fd1210e557
Complete task002 through task016 across cache correctness, editor lifecycle, C boundaries, build and release governance, dictionary provenance, performance, interactive workflows, tests, documentation, and final cleanup.
18 lines
637 B
Markdown
18 lines
637 B
Markdown
# Plan: Documentation Improvement
|
|
|
|
## Milestones
|
|
1. **Structure Setup**: Initialize `.phrase` and new files.
|
|
2. **Extraction**: Move technical content from READMEs to DEVELOPER docs.
|
|
3. **Enhancement**: Flesh out API details in DEVELOPER docs using source code as reference.
|
|
4. **Polish**: Refine User Guide in READMEs.
|
|
|
|
## Scope
|
|
- Files: `readme.md`, `readme_zh.md`, `DEVELOPER.md` (new), `DEVELOPER_ZH.md` (new).
|
|
- Languages: English, Chinese.
|
|
|
|
## Dependencies
|
|
- Source code (`ekp.el`, `ekp_c/*`) for accurate API documentation.
|
|
|
|
## Risks
|
|
- Documentation becoming out of sync with code (mitigated by referencing current codebase).
|