documentation-skill

Ask for a README describing your component, and the Skill produces a structured document covering purpose, inputs, outputs, dependencies, and execution flow. It follows principles of clarity, conciseness, and technical accuracy.

Google-style docstrings start with a one-line summary, followed by an Args section describing each parameter and a Returns section describing the result. The Skill generates this format automatically for Python code you provide.

Architecture documentation should explain what each component does, how it works, how to use it, and how it integrates with the system. Every major component needs its purpose, inputs, outputs, dependencies, and execution flow documented.

Yes, the Skill covers API documentation, setup instructions, and developer guides in addition to READMEs and docstrings. It applies whenever you are documenting code or a user asks for documentation.

Generated documentation reflects only the code and context provided, so undocumented interfaces or implicit behavior may be missed. Review output for technical accuracy before publishing, especially for complex integration points.