Docs Maintenance

新功能、配置、命令或发布流程变化后维护 README 与工程文档,核对代码事实、精简重复内容并修复失效说明。

lakernote 994f8b3 1.1 KB Updated

File contents

Documentation maintenance

  1. 先确定目标读者和文档层级:README 保留定位、主要能力、快速开始和关键边界;实现细节放到专题文档,避免同一说明多处复制。
  2. 用真实代码、配置默认值、命令帮助、路由和 CI 工作流核对文档。不要把计划、推测或本地偶然状态写成产品事实。
  3. 示例命令应可复制,路径、端口、环境变量、平台差异和前置依赖必须与当前实现一致;能安全执行时实际验证关键命令。
  4. 新功能同时检查相邻旧描述是否失效,例如超时、认证、恢复语义、支持平台、截图和当前边界,避免只追加不修正。
  5. 优先删除重复、过时和没有决策价值的文字;保留必要的风险提示、迁移信息和指向详细文档的链接。
  6. 最终说明更新了哪些用户行为、验证了哪些命令或链接,以及仍需要产品确认或重新截图的内容。

lakernote/easy-agent/tree/main/internal/builtin/skills/definitions/docs-maintenance commit 994f8b3f38

Frequently asked questions

npx skillmds@latest add lakernote/docs-maintenance