documentation
Use for PLANNING documentation with phased analysis (4 phases), gap identification, and structured knowledge modeling. Best for documentation audits, completeness analysis, and documentation strategy planning. NOT for writing actual docs (use tasks-documentation instead).
Security Assessment
About documentation
The 'documentation' skill is designed to assist in enhancing software documentation, focusing on improving code comments, API documentation, README files, and other technical documentation aspects. It addresses the common challenge of ensuring that documentation is accurate, up-to-date, and aligned with the actual functionality of the codebase. This skill helps automate the process of generating and improving documentation, reducing the manual effort and ensuring that the documentation accurately reflects the code’s behavior and structure.
Main features of this skill include a detailed documentation process involving analysis, planning, approval, and execution stages. The analysis phase identifies gaps in existing documentation and creates a knowledge model. The planning phase generates a detailed outline and priorities for documentation work. After receiving explicit user approval, the execution phase writes the documentation according to strict guidelines that prevent hallucination or speculation. This ensures that the documentation is both reliable and practical, offering real examples and code snippets for better understanding.
The 'documentation' skill is ideal for developers, technical writers, and teams looking to improve or generate comprehensive documentation for their projects. It is particularly useful for enhancing the quality of API documentation, code comments, and README files, with an emphasis on verifiable, evidence-based documentation that ensures users can trust the provided content.
FAQ
How do I start using the documentation skill?
Begin by initiating the skill with a request related to enhancing documentation, such as improving README files, adding code comments, or generating API documentation. The skill will guide you through a structured process involving analysis, planning, and user approval before execution.
What types of documentation can this skill help with?
This skill focuses on enhancing code documentation, API documentation, and README files. It ensures that these documents are complete, accurate, and up to date, following a systematic approach to document generation and improvement.
Is this skill compatible with all programming languages?
Yes, the documentation skill is language-agnostic and can be applied to projects in any programming language as long as the documentation itself needs improvement, such as API documentation or code comments. However, specific language patterns may require some adjustments to the process.
What are the limitations of this skill?
The skill works strictly within the realm of code documentation and README files. It does not support business feature documentation, which should be handled by the 'feature-docs' skill. Additionally, speculative documentation or claims without proof are strictly forbidden.
Install documentation
Quick Setup:
- Copy the skill folder to
.claude/skills/ - Claude will automatically detect and use the skill
Repository
duc01226/EasyPlatform