Community写作与编辑github.com

docs-system — 文档系统

便携式文档系统:分类法+类别文件夹+MEMORIAL汇编,以AgentFactory代理/技能形式打包,附带bootstrap/migrate/compile/append脚本。

docs-system — 文档系统 是什么?

docs-system 是一个便携式文档系统,针对 AI Agent 和开发者设计,用于在任何代码仓库中安装并维护一套完整的文档组织体系。它基于固定的分类法(Taxonomy)和类别文件夹,通过四个幂等脚本(bootstrap、migrate、compile、append)实现文档的初始化、迁移、索引生成和增量更新。支持 AgentFactory(Claude Code 等兼容 Agent 规范的环境),强制在每次文档创建或修改后重新编译对应文件夹的 MEMORIAL.md 汇编文件,以保持索引始终最新。迁移脚本默认使用 --dry-run 模式,确保安全预览后再执行 --apply,并且所有操作都通过 git mv 保留历史记录。适合需要文档分类、交叉引用和长期维护的项目。

兼容平台~Claude Code~Codex CLI~Cursor
npx skills add matheusmlopess/docs-system

Installed? Explore more 写作与编辑 skills: steipete/notion, langchain-ai/langchain, bytedance/podcast-generation · View all 6 →

在你喜欢的 AI 中提问

打开一个已预加载此 Agent Skill 的新对话。

文档

docs-system — v1.0.0

在任何仓库中安装和维护完整的文档系统。当项目需要文档组织、分类、建立索引并保持同步时,或者当被要求“设置文档系统/文档分类法/文档汇编”时使用此技能。

该技能由四个脚本(位于 scripts/ 目录)实现,按顺序调用。所有脚本都是幂等的,并且保留历史记录(使用 git mv);迁移操作需审核后执行(先执行 --dry-run)。


何时使用

  • 仓库中有散乱、未分类的文档 → 安装系统并进行迁移。
  • 文档被创建或编辑 → 重新生成该文件夹的汇编(强制步骤)。
  • 有人要求提供文档索引/术语表/“备忘”/分类法。

命令(脚本)

命令脚本目的
bootstrapscripts/docs-bootstrap.sh <repo>安装工具包:创建分类文件夹、复制治理文档(分类法/模板/快速入门/注册表/术语表)、安装4个脚本、将文档规则追加到 Agent 配置文件中。幂等。
migrate`scripts/docs-migrate.sh [--dry-run--apply] `
compilescripts/docs-compile.sh <folder>(重新)构建 <folder>/MEMORIAL.md — 按日期排序的文档汇编,包含索引、术语链接和完整正文。确定性重建:幂等/自动追加/去重/排序。--clean <folder> 删除该汇编。
appendscripts/docs-append.sh <doc> ["summary"]为文档在其文件夹的 README.md 索引中添加一行链接(幂等)。

标准工作流

# 1. 配置(每个仓库执行一次)
cp docs-system.conf.example .docs-system.conf   # 编辑 PROJECT_NAME, AGENT_RULES, PLAN_BUCKET

# 2. 安装
scripts/docs-bootstrap.sh .

# 3. 迁移现有文档 — 先执行 DRY-RUN,审核,再执行 apply
scripts/docs-migrate.sh --dry-run .
scripts/docs-migrate.sh --apply .

# 4. 构建汇编
for d in documentation features testing reviews changes PLANS; do
  scripts/docs-compile.sh "docs/$d"
done

# 5. 完成:重新填充 docs/documentation/DOCUMENTATION-REGISTRY.md,编辑 GLOSSARY.md 中的项目术语

强制持续规则

在你创建或编辑 docs/<folder>/ 下的任何文档之后,必须运行 scripts/docs-compile.sh docs/<folder>,并将重新生成的 MEMORIAL.md 与文档一起提交。 不要手动编辑 MEMORIAL.md(它是自动生成的)。此规则也会由 bootstrap 写入目标仓库的 Agent 规则文件中。

文档头部标记(强制)

每个 .md 文件在 H1 标题下包含: <!-- version --> · <!-- classification: TYPE --> · <!-- date --> · <!-- last-updated -->。 date 在创建时设置一次;只有 last-updated 在编辑时更改。类型包括: FEATURE / TESTING / DESIGN / GAPS / ANALYSIS / CHANGE / STUDY / REVIEW / ARCHITECTURE / SUMMARY / PLAN。

安全 / 回滚

  • docs-migrate.sh 默认使用 --dry-run;在执行 --apply 前请审核表格。
  • 回滚汇编:scripts/docs-compile.sh --clean docs/<folder> 或 find docs -name MEMORIAL.md -delete。
  • 所有操作都有 git 跟踪;git revert 可以撤销一次运行。移动操作是重命名(保留历史)。

参考

  • references/PLAYBOOK.md — 完整流程、配置参数、验证、回滚。

相关技能