documentation-management

What problem does it solve?

Creating high-quality, consistent, and maintainable documentation is often time-consuming and prone to errors. This Skill provides a systematic methodology with empirically validated templates, patterns, and automation tools to streamline the entire documentation lifecycle, ensuring clarity and accuracy.

Core Features & Use Cases

• Validated Templates: Access 5 empirically validated templates (e.g., Tutorial, Concept, Troubleshooting) for consistent structure and 93% transferability across diverse documentation types.
• Core Patterns: Apply 3 proven patterns like "Progressive Disclosure" (simple to complex) and "Example-Driven Explanation" (concept + example) to enhance clarity and user comprehension.
• Automation Tools: Utilize Python-based tools for link validation (30x speedup) and command syntax validation (20x speedup) to prevent common errors and integrate with CI/CD pipelines.
• Use Case: When starting a new project, use the tutorial-structure.md template to quickly create a comprehensive onboarding guide, then run validate-links.py and validate-commands.py to ensure all external resources are accessible and code snippets are correct.

Quick Start

Copy the appropriate template

cp .claude/skills/documentation-management/templates/tutorial-structure.md docs/tutorials/my-guide.md

Follow the template structure and guidelines

Fill in sections with your content

Validate all links

python .claude/skills/documentation-management/tools/validate-links.py docs/

Validate command syntax

python .claude/skills/documentation-management/tools/validate-commands.py docs/