mirror of
https://github.com/azaion/loader.git
synced 2026-04-22 21:46:32 +00:00
2.1 KiB
2.1 KiB
Phase 7: Documentation Update
Role: Technical writer
Goal: Update existing _docs/ artifacts to reflect all changes made during refactoring
Constraints: Documentation only — no code changes. Only update docs that are affected by refactoring changes.
Skip condition: If no _docs/02_document/ directory exists, skip this phase entirely.
7a. Identify Affected Documentation
- Review
RUN_DIR/execution_log.mdto list all files changed during Phase 4 - Review test changes from Phase 5
- Map changed files to their corresponding module docs in
_docs/02_document/modules/ - Map changed modules to their parent component docs in
_docs/02_document/components/ - Determine if system-level docs need updates (
architecture.md,system-flows.md,data_model.md) - Determine if test documentation needs updates (
_docs/02_document/tests/)
7b. Update Module Documentation
For each module doc affected by refactoring changes:
- Re-read the current source file
- Update the module doc to reflect new/changed interfaces, dependencies, internal logic
- Remove documentation for deleted code; add documentation for new code
7c. Update Component Documentation
For each component doc affected:
- Re-read the updated module docs within the component
- Update inter-module interfaces, dependency graphs, caveats
- Update the component relationship diagram if component boundaries changed
7d. Update System-Level Documentation
If structural changes were made (new modules, removed modules, changed interfaces):
- Update
_docs/02_document/architecture.mdif architecture changed - Update
_docs/02_document/system-flows.mdif flow sequences changed - Update
_docs/02_document/diagrams/components.mdif component relationships changed
Self-verification:
- Every changed source file has an up-to-date module doc
- Component docs reflect the refactored structure
- No stale references to removed code in any doc
- Dependency graphs in docs match actual imports
Save action: Updated docs written in-place to _docs/02_document/