project-documentation

What problem does it solve?

This Skill helps teams build and maintain a high-fidelity documentation ecosystem that serves as the single source of truth for developers, stakeholders, and AI agents, reducing onboarding time and miscommunication.

Core Features & Use Cases

• Documentation Hierarchy: Defines the standard structure: README.md as the map, ADRs, Technical Docs, SOPs/Skills, and Inline Docs.
• Writing Standards: Enforces readability, conciseness, and clear acronym definitions to improve collaboration.
• Maintenance & Anti-Rot Strategy: Promotes "Doc-as-Code" workflow, automated validation (link checks, snippet testing), and versioned docs.
• Onboarding & Governance: Guides new contributors and ensures governance over changes.
• ADR Template & Quick Reference: Provides templates and quick references to standardize decisions.

Quick Start

Review the repository's documentation structure and ensure the following are up to date: README.md exists as the map, ADRs for major decisions are present, Technical Docs and SOPs/Skills sections are current. Create or update an ADR for the latest architectural change and verify that CI checks for documentation (link checks, snippet testing) are enabled.