What are the [IN], [OUT], and [POS] tags?

They represent Dependencies ([IN]), Exports or side effects ([OUT]), and the file's architectural Position/Layer ([POS]).

How do I validate the generated documentation?

After the skill completes its task, you can run the 'pnpm doc-lint' command to ensure all files comply with the protocol.

Does it support multiple languages?

Yes, the templates provided by this skill include fields for both English and Chinese descriptions.

What is the Fractal Docs Protocol?

It is a self-describing documentation system that uses specific file headers and folder-level markdown files to maintain architectural context within a codebase.

When does this skill activate?

The skill triggers when creating or modifying source files, creating new folders, or when keywords like 'fractal' or 'add headers' are used.

Fractal Docs Protocol

Name: Fractal Docs Protocol
Author: coderguai

bycoderguai

0•

콘텐츠 관리

Implements the Fractal Docs Protocol by automatically generating and updating structured file headers and folder documentation.

The Fractal Docs Protocol skill streamlines technical documentation by enforcing a self-describing system within your codebase. It automatically manages three-line file headers containing dependencies, exports, and system positioning, while maintaining .folder.md files to describe directory responsibilities and boundaries. By ensuring that every file and folder has its context documented in real-time, it reduces cognitive load for developers and ensures documentation never falls out of sync with the source code.

주요 기능

01Automated .folder.md generation for directory-level context

02Bilingual documentation support (English and Chinese)

03Synchronized updates between source files and parent folder metadata

04Documentation audit and linting integration

05Automatic header injection with [IN], [OUT], and [POS] tags

060 GitHub stars

사용 사례

01Onboarding new developers by providing immediate file and folder context

02Establishing a standardized documentation-as-code protocol across a large repository

03Automating the maintenance of dependency and export lists during refactors

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add coderguai/server-up-box fractal-docs

For use in Claude.ai and ChatGPT

Download Skill