文档维护规范
每个事实只保留一个维护入口:根 README 负责定位和最短上手,docs/README.md 负责完整导航,参考手册负责精确 API,AI 速读页负责编码契约,TESTING.md 负责可复现验证。
文档示例必须使用当前公开 API,说明依赖模块、返回值、异常和生命周期。修改 API、配置或行为时,先更新测试和事实来源,再更新教程与索引。临时方案、审计记录、推广稿和文章素材放入本地 .local-docs/,不进入公开文档树。
每个事实只保留一个维护入口:根 README 负责定位和最短上手,docs/README.md 负责完整导航,参考手册负责精确 API,AI 速读页负责编码契约,TESTING.md 负责可复现验证。
文档示例必须使用当前公开 API,说明依赖模块、返回值、异常和生命周期。修改 API、配置或行为时,先更新测试和事实来源,再更新教程与索引。临时方案、审计记录、推广稿和文章素材放入本地 .local-docs/,不进入公开文档树。