docs-maintenance
Maintain sloc-guard project documentation. Use when user completes a feature and asks to update docs.
When & Why to Use This Skill
The Docs-Maintenance skill is designed to automate and streamline the upkeep of technical documentation for the sloc-guard project. It ensures that critical files like the Implementation Plan and Project Overview stay synchronized with the latest code changes, focusing on conciseness to optimize AI context usage and project clarity.
Use Cases
- Post-Feature Synchronization: Automatically update module status tables and mark tasks as completed in 'Implementation Plan.md' immediately after a feature is finalized.
- Architecture Alignment: Refresh the Module Map, Key Types, and Data Flow sections in 'PROJECT_OVERVIEW.md' to reflect structural changes in the codebase.
- Context Optimization: Clean up redundant or outdated documentation content to reduce token consumption and improve the efficiency of AI-assisted development.
| name | docs-maintenance |
|---|---|
| description | Maintain sloc-guard project documentation. Use when user completes a feature and asks to update docs. |
Documentation Maintenance
Maintenance Principle: Keep concise, avoid redundancy, clean up outdated content promptly to reduce AI context usage.
When user completes a feature and requests doc updates, update these three files:
docs/Implementation Plan.md- Update module status table, check off completed tasksdocs/PROJECT_OVERVIEW.md- Update Module Map, Key Types, Data Flow as needed