fractal-docs

Automatically add or update documentation following the Fractal Docs Protocol.自动添加或更新符合分形文档协议的文档。Use when:- Creating new source files (add [IN]/[OUT]/[POS] headers)- Creating new folders (add .folder.md)- Modifying existing files (update headers and .folder.md)- Running documentation audit- User mentions "fractal", "doc protocol", "add headers", "补全文档"

⭐5stars🔀1forks📁View on GitHub🕐Updated Jan 11, 2026⬇️1downloads

When & Why to Use This Skill

The Fractal Docs Protocol skill automates the creation and maintenance of self-describing code documentation. By enforcing a structured metadata system—including file-level headers ([IN], [OUT], [POS]) and folder-level descriptions (.folder.md)—it ensures architectural clarity, improves codebase navigability, and streamlines the developer onboarding process through consistent, AI-assisted documentation updates.

Use Cases

  • Automatically generating standardized 3-line headers for new source files to track dependencies, exports, and system positioning.
  • Creating and updating '.folder.md' files during directory restructuring to maintain a clear record of folder responsibilities and file invariants.
  • Performing documentation audits across existing codebases to identify and fix missing or outdated protocol headers.
  • Syncing architectural metadata during code refactoring to ensure that file-level changes are reflected in parent folder documentation.
  • Improving AI context and developer understanding by providing a self-describing structure that explains the 'why' and 'where' of every file.
namefractal-docs
description|

Fractal Docs Protocol Skill / 分形文档协议技能

设计思路 / Design Notes:

  1. description 明确列出功能和触发词(fractal, doc protocol, 补全文档等)
  2. 提供完整模板,减少 Claude 的猜测
  3. 分步骤指令,确保执行顺序正确

Overview / 概述

This skill helps maintain the Fractal Docs Protocol - a self-describing documentation system. 此技能帮助维护分形文档协议 - 一个自描述的文档系统。

Instructions / 指令

When Creating/Modifying Source Files / 创建或修改源文件时

  1. Check if file has header / 检查文件是否有头注释
  2. Add or update the 3-line header / 添加或更新 3 行头注释:
// [IN]: <dependencies> / <依赖说明>
// [OUT]: <exports> / <导出说明>
// [POS]: <position in system> / <系统定位>
// Protocol: When updating me, sync this header + parent folder's .folder.md
// 协议:更新本文件时,同步更新此头注释及所属文件夹的 .folder.md
  1. Update parent folder's .folder.md / 更新父文件夹的 .folder.md

When Creating Folders / 创建文件夹时

Create .folder.md with this template / 使用此模板创建 .folder.md:

# Folder: <path>

> Trigger: When this folder's structure/responsibilities/file list changes, update this document.
> 触发条件:当本文件夹的结构/职责/文件列表变化时,更新此文档。

<Line 1: Responsibility / 职责>
<Line 2: Boundary / 边界>
<Line 3: Key invariant / 关键不变量>

## Files
- `<file>`: <position> - <description EN> / <description CN>

Header Content Guidelines / 头注释内容指南

Tag Content Example
[IN] Dependencies, imports @repo/db, ../orpc / 依赖数据库和 oRPC
[OUT] Exports, side effects postRouter object / 导出文章路由
[POS] Layer, responsibility API layer - Post handlers / API 层 - 文章处理器

Validation / 验证

After completing changes, run:

pnpm doc-lint

Reference / 参考