code-documenter
Installation
SKILL.md
Code Documenter
⚠️ MANDATORY COMPLIANCE ⚠️
CRITICAL: The 5-step workflow outlined in this document MUST be followed in exact order for EVERY documentation task. Skipping steps or deviating from the procedure will result in incomplete and unreliable documentation. This is non-negotiable.
File Structure
- SKILL.md (this file): Main instructions and MANDATORY workflow
- examples.md: Documentation scenarios with sample outputs
- Context: Relevant domain context loaded via
contextProvider. See ContextProvider Interface. - Memory: Project-specific memory accessed via
memoryStore.getSkillMemory("code-documenter", "{project-name}"). See MemoryStore Interface.
Documentation Focus Areas
Comprehensive code documentation covers 6 critical dimensions: