Agent Skills
返回列表
产品开发文档全生命周期

产品开发文档全生命周期

AI Agent 更新于 2026.08.29

将以下提示词粘贴到你的 AI 对话框中：

请根据 https://skillhub.cn/install/skillhub.md 的说明，在你的 AI 助手中安装 @user_14a4dd77/product-doc-lifecycle-ai。

技能介绍

问题背景

团队常见两种极端：立项时一口气建齐 01-requirements 到 07-release-notes 的空壳，没人维护；或者 README 之外什么都不写，接手的人只能翻 commit。更麻烦的是文档和代码各走各的——API 改了 04-api 没动，发版时 CHANGELOG 和 07-release-notes 版本号对不上。子项目、微服务混在一个仓库里时，命名和「该写哪一份」更容易扯皮。

技能如何工作

本技能把 文档跟随代码进度 当作硬原则：禁止初期空占位，按 S0～S6 阶段在触发条件满足时再建对应文档（例如需求评审通过才建 01-requirements，API 第一稿完成才建 04-api）。

  • 复杂度分级：简单 / 中等 / 复杂对应不同的最小文档集；简单项目不必强行凑齐七份核心文档。
  • 命名与目录：核心文档 {序号}-{kebab-case}.md，版本号写在文件头，不进文件名；子项目用 {子项目ID}-{序号}-{type}.md。
  • 变更同步：规定代码变更与文档更新应在 同一 commit / PR 内完成，并列出「改 API → 更新 04-api + openapi.yaml」等映射。
  • AI Agent 规则：读取顺序 README → 架构 → API → 数据库；修改代码后同一 turn 更新文档；接手新项目时先列 docs/ 对照最小集报告缺失，不自动创建。

子项目另有创建 / 开发 / 冻结 / 归档 / 废弃五阶段及微服务架构文档补充章节模板。

适用边界

纯代码调试、一次性脚本、用户明确不要文档，或只问单个文件内容时 不应触发 本技能。详细字段边界与模板在技能引用的 references/doc-spec.md、references/templates.md，执行时需与仓库实际复杂度对齐，避免简单项目被当成复杂项目全量建档。

使用场景

  • 仓库刚立项只有 README，需要按 S0～S6 判断下一里程碑该补哪份核心文档、而不是先建空目录占位
  • API 端点或请求体改动后，要在同一 PR 里同步更新 `04-api.md` 与 `openapi.yaml`，并对照变更类型表检查是否还要动需求或架构文档
  • 接手他人项目时先扫描 `docs/`，按简单/中等/复杂最小文档集列出缺失项，再决定是否创建
  • 子项目独立部署或微服务拆出后，按 `{sp}-02-architecture` 补服务发现、依赖拓扑等章节，并走创建→开发→冻结生命周期

适合人员

  • 负责小团队单仓库、要在需求评审与架构定稿之间控制文档粒度的技术负责人
  • 每次改接口都要保证 OpenAPI 与 Markdown API 文档同 PR 落地的后端或全栈工程师
  • 维护含多个子项目或微服务目录、需要统一 kebab-case 命名与子项目归档规则的平台工程师
  • 发版打 tag 前要把 CHANGELOG 的 [Unreleased] 归档并同步各核心文档头部版本号的发布维护者