outfitter-documentation

What problem does it solve?

This Skill provides a standardized structure, templates, and best practices for creating comprehensive and maintainable project documentation, ensuring clarity for both human users and AI agents.

Core Features & Use Cases

• Directory Structure: Defines a clear hierarchy for organizing documentation files (README, CONTRIBUTING, CHANGELOG, docs/ directory with subfolders for architecture, api, cli, guides, development).
• README Standards: Offers guidelines on README structure, length, and content prioritization, including specific patterns for different project types and stability tier labels.
• Documentation Hierarchy: Emphasizes a multi-level approach to documentation, from code types and inline comments to dedicated documentation files.
• Use Case: When starting a new project or refactoring an existing one, use this Skill to ensure all necessary documentation components are present and follow established conventions, making the project easier to understand and contribute to.

Quick Start

Use the outfitter-documentation skill to generate a standard README file for a new project.