Documentation Guide

•
69
•

Standardizes project documentation structure and content based on universal development standards for various project lifecycles.

The Documentation Guide skill implements the Universal Development Standards (UDS) to provide Claude with a comprehensive framework for creating, auditing, and maintaining project documentation. It defines a documentation pyramid—ranging from high-level READMEs to deep technical API and Database references—and includes a requirement matrix that adjusts based on whether a project is new, undergoing a refactor, or in maintenance. By using this skill, developers ensure their projects remain well-documented with standardized templates for ADRs, deployment guides, and system architectures, facilitating better team collaboration and long-term maintainability.

주요 기능

01Project-specific documentation matrices (New, Refactor, Migration, Maintenance)
02Hierarchical documentation pyramid for structured information flow
0369 GitHub stars
04Standardized templates for Architectural Decision Records (ADRs)
05Best practices for Mermaid diagram integration and file naming conventions
06Comprehensive quality checklists for technical documentation audits

사용 사례

01Recording significant technical changes using the standardized ADR template
02Auditing existing repositories to identify missing or outdated documentation
03Bootstrapping a new project with the correct README, architecture, and deployment files