文档中心(Documentation Index)

September 8, 2026 · View on GitHub

本文件是本仓库文档索引与层级规范的入口:所有规范文档的导航、层级规则、命名约定与维护流程。

文档层级

docs/
├── README.md             ← 本索引(入口/导航)
├── DEVELOPMENT.md        ← 文档源规范(meta):提交/代码/文档/测试/Changelog 总纲
├── CONTRIBUTING.md       ← 贡献指南:Fork/分支/提交/PR 流程
├── GIT_HOOKS.md          ← Git Hook 规范:Hook 清单/分级机制/emoji 全覆盖/跨平台
├── CODING_STANDARDS.md   ← 代码规范:注释/命名/错误处理/多端兼容/安全
├── TESTING.md            ← 测试规范:金字塔架构/覆盖率/e2e 策略/workspace 陷阱
├── FEEDBACK.md           ← 安装反馈系统规范:模板/诊断字段/脱敏机制/隐私边界
├── CHANGELOG.md          ← 版本迭代记录(双语)
├── SKIN-MANIFEST-SPEC.md ← 皮肤清单格式规范(实现:lib/skin-manifest.js)
├── SKIN-MANIFEST-RECORD.md ← 皮肤清单维护记录(生成器输出/验证)
├── REFERENCE.md         ← 参考项目记录(平行生态/可借鉴的外部项目)
└── LIB-ISSUES.md         ← 测试发现的 lib API 问题(待商讨提交 upstream)

层级规则

层级职责文件
L0 索引导航入口、层级说明、维护流程docs/README.md
L1 源规范(meta)全仓库行为总纲,冲突时最高优先docs/DEVELOPMENT.md
L2 专项规范单一领域的详细规则docs/GIT_HOOKS.mddocs/CODING_STANDARDS.mddocs/TESTING.mddocs/FEEDBACK.mddocs/SKIN-MANIFEST-SPEC.md
L3 执行层纯函数实现(可测)、Hook、脚本scripts/hooks/*.mjsscripts/toc.mjs

规范冲突解决:L1 > L2 > 项目 README > 社区惯例。新增规范先在 L1 确立,再细化到 L2。

文档命名约定

  • kebab-case(GIT_HOOKS.md 为既有名,新文档用 CODING-STANDARDS.md 风格)
  • 每文档必须包含 TOC(<!-- TOC --> 占位,由 scripts/toc.mjs 生成)
  • 双语规范:需对外发布的文档提供 .en.md 镜像

维护流程

  1. 新规范 → 先在 docs/DEVELOPMENT.md 确立(L1)
  2. 细化 → 新建 docs/ 专项文档(L2),更新本索引
  3. 落地 → 实现为纯函数 + unit 断言 + Git Hook
  4. 验证 → node scripts/toc.mjs --check + node scripts/tests/run.mjs + pre-commit hook