Doc-Sync: Self-Documenting Architecture

Acerca de

Doc-Sync implements a 'Documentation = Code' philosophy by establishing a mandatory three-level hierarchy for project documentation. It ensures that every functional, architectural, or implementation change is immediately reflected in the root README, directory-specific folder.md files, and individual file header annotations (INPUT/OUTPUT/POSITION). This skill is ideal for teams and solo developers who want to maintain a highly discoverable, well-mapped codebase where the documentation is as reliable as the source code itself.

Características Principales

• Automated bash scripts for checking documentation coverage and missing headers
• Standardized file header annotations for inputs, outputs, and architectural roles
• Standardized templates for creating new self-documenting source files
• 0 GitHub stars
• Three-level documentation hierarchy (Root, Folder, and File)
• Mandatory folder.md role-mapping for every directory

Casos de Uso

• Accelerating developer onboarding by providing immediate context for every file and folder
• Maintaining accurate architectural maps during rapid codebase refactoring
• Standardizing documentation practices across large-scale engineering teams