documentation-writing

Auditing project documentation involves scanning files like project.md and architecture.md to detect code blocks, duplication, and outdated data. This skill generates a status report highlighting inconsistencies and issues across your references directory.

Keeping technical documentation consistent requires verifying terminology and data points across all files. This skill checks consistency in your project knowledge directory and edits specific sections to reflect code changes accurately.

Updating architecture.md and project.md files is handled by editing specific sections based on user requests. The skill modifies documentation directly, ensuring new team members understand the project state without reading code.

Checking the completeness of deployment.md and patterns.md is supported through a status reporting feature. The skill evaluates the state of these core files within the references directory and reports their current completeness.

Avoiding code blocks in project documentation ensures it remains concise and useful for high-level understanding without duplicating the codebase. This skill audits your files and flags any code blocks that violate this documentation principle.