docs-system — v1.0.0
在任何仓库中安装和维护完整的文档系统。当项目需要文档组织、分类、建立索引并保持同步时,或者当被要求“设置文档系统/文档分类法/文档汇编”时使用此技能。
该技能由四个脚本(位于 scripts/ 目录)实现,按顺序调用。所有脚本都是幂等的,并且保留历史记录(使用 git mv);迁移操作需审核后执行(先执行 --dry-run)。
何时使用
- 仓库中有散乱、未分类的文档 → 安装系统并进行迁移。
- 文档被创建或编辑 → 重新生成该文件夹的汇编(强制步骤)。
- 有人要求提供文档索引/术语表/“备忘”/分类法。
命令(脚本)
| 命令 | 脚本 | 目的 |
|---|---|---|
| bootstrap | scripts/docs-bootstrap.sh <repo> | 安装工具包:创建分类文件夹、复制治理文档(分类法/模板/快速入门/注册表/术语表)、安装4个脚本、将文档规则追加到 Agent 配置文件中。幂等。 |
| migrate | `scripts/docs-migrate.sh [--dry-run | --apply] ` |
| compile | scripts/docs-compile.sh <folder> | (重新)构建 <folder>/MEMORIAL.md — 按日期排序的文档汇编,包含索引、术语链接和完整正文。确定性重建:幂等/自动追加/去重/排序。--clean <folder> 删除该汇编。 |
| append | scripts/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— 完整流程、配置参数、验证、回滚。