What is the core principle of the Doc-Sync skill?

The core principle is 'Documentation = Code,' meaning any functional or architectural change must update its corresponding documentation immediately before work is considered complete.

What are the three levels of documentation required?

Level 1 is the Root README.md for high-level changes; Level 2 is the directory-specific folder.md for structural changes; Level 3 is File Header Annotations for specific implementation details.

Is Doc-Sync limited to specific programming languages?

No, while the examples provided use TypeScript, the pattern of using folder.md and standardized file headers can be applied to any programming language or project structure.

How do I check if my project is missing documentation?

The skill provides shell commands to find directories missing a folder.md file and source files that are missing the mandatory INPUT/OUTPUT header annotations.

What information goes into a file header annotation?

Every file header must specify its INPUT (external dependencies), OUTPUT (exports or provides), and POSITION (the file's specific role in the system architecture).

Doc-Sync: Self-Documenting Architecture

Name: Doc-Sync: Self-Documenting Architecture
Author: LixvYang

byLixvYang

0•

コンテンツ管理

Enforces a strict synchronization pattern between code changes and project documentation to eliminate documentation rot.

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.

主な機能

01Automated bash scripts for checking documentation coverage and missing headers

02Standardized file header annotations for inputs, outputs, and architectural roles

03Standardized templates for creating new self-documenting source files

040 GitHub stars

05Three-level documentation hierarchy (Root, Folder, and File)

06Mandatory folder.md role-mapping for every directory

ユースケース

01Accelerating developer onboarding by providing immediate context for every file and folder

02Maintaining accurate architectural maps during rapid codebase refactoring

03Standardizing documentation practices across large-scale engineering teams

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add lixvyang/common-skills doc-sync

For use in Claude.ai and ChatGPT

Download Skill