Documentation Guide Skill

Documentation standards and automation for [PROJECT_NAME] project.

When This Skill Activates

• Keywords: documentation, docs, readme, changelog, guides, api docs, parity, validation, docstring, standards

Core Concepts

Overview

This skill provides comprehensive guidance on documentation guide. For detailed patterns and implementation examples, see the documentation files in docs/.

Key Topics:

• Detailed methodologies and best practices
• Implementation patterns and examples
• Common pitfalls and anti-patterns
• Cross-references to related skills

See: Documentation files in docs/ directory for complete details

Quick Reference

Progressive Disclosure

This skill uses progressive disclosure to prevent context bloat:

• Index (this file): High-level concepts and quick reference (<500 lines)
• Detailed docs: docs/*.md files with implementation details (loaded on-demand)

Available Documentation:

• docs/changelog-format.md - Detailed implementation guide
• docs/detailed-guide-1.md - Detailed implementation guide
• docs/detailed-guide-2.md - Detailed implementation guide
• docs/detailed-guide-3.md - Detailed implementation guide
• docs/detailed-guide-4.md - Detailed implementation guide
• docs/docstring-standards.md - Detailed implementation guide
• docs/parity-validation.md - Detailed implementation guide
• docs/readme-structure.md - Detailed implementation guide
• docs/research-doc-standards.md - Research documentation standards

Cross-References

Related Skills:

• See PROJECT.md for complete skill dependencies

Related Tools:

• See documentation files for tool-specific guidance

Key Takeaways

1. Research existing patterns before implementing
2. Follow established best practices
3. Refer to detailed documentation for implementation specifics
4. Cross-reference related skills for comprehensive understanding