关于 docs-agile-integration
面向技术写作者和产品团队的技能,帮助将文档纳入敏捷规划、交付与维护。它提供工作流,使文档工作贴合产品节奏,同时明确管理跨迭代任务。
主要功能
- 01梳理敏捷流程与文档缺口
- 02将文档关联到产品工作
- 03将文档检查纳入完成定义
- 04规划跨迭代文档工作
- 05跟踪回顾与客户反馈信号
适用场景
- 01发现团队看板中遗漏的文档任务
- 02将文档检查加入发布就绪流程
- 03规划跨团队或跨迭代维护工作
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ lvtd-llc/ skills --skill docs-agile-integration安装后在 Claude Code 中输入/docs-agile-integration确认已加载。
包含的文件
除 SKILL.md 外,安装时一起下载的参考资料和脚本。
guidelines.mdreferences/core/knowledge.mdworkflows/define-docs-done.mdintegrate-docs-agile.md详细介绍
Docs 敏捷集成
使用此技能,将文档集成到敏捷产品开发流程中,而不掩盖文档专属工作。它能帮助写作者和产品团队按照产品决策的节奏规划文档、评审、发布准备和维护工作。
此技能改编自 Christopher Gales 和 Splunk Documentation Team 所著 The Product Is Docs: Writing Technical Documentation in a Product Development Group 中的转述指导,尤其是第 2 章“Agile”、第 19 章“Working with Engineers”、第 22 章“Working with Product Management”和第 23 章“Working on a Remote Team”。请勿在面向用户的输出中照搬书中的原文。来源:https://link.springer.com/book/10.1007/978-1-4842-7217-6
快速入门
- 加载
guidelines.md,选择最精简且实用的参考资料集。 - 确定团队的敏捷节奏、规划制品、发布模式,以及文档目前在哪些环节不可见。
- 使用
workflows/integrate-docs-agile.md将文档工作纳入产品工作。 - 使用
workflows/define-docs-done.md,将文档检查纳入完成定义或发布准备流程。 - 将功能冲刺文档与合理跨越多个冲刺或团队的文档工作区分开来。
- 返回建议的看板变更、文档任务、评审检查点、阻碍因素和回顾信号。
默认输出
将文档集成到敏捷工作中时,请返回:
- 当前流程图 - 节奏、制品、看板、角色、发布关卡和评审路径。
- 文档可见性缺口 - 缺少文档影响、任务、阻碍因素、评审或发布准备的环节。
- 建议的工作流 - 事项单关联模型、规划检查点、负责人和评审时间安排。
- 完成定义更新 - 文档影响、草稿、评审、QA、发布、发行说明和维护检查。
- 跨冲刺处理 - 如何让场景、维护、信息架构或跨团队文档持续可见,而不强行将其塞进单个冲刺。
- 检查与调整信号 - 支持反馈、评审遗漏、文档延迟、内容过时情况和回顾行动。
目录
| 需求 | 从此处开始 |
|---|---|
| 了解文档与敏捷概念 | references/core/knowledge.md |
| 将文档纳入规划和看板 | workflows/integrate-docs-agile.md |
| 定义文档完成状态和发布准备 | workflows/define-docs-done.md |
| 按任务或症状选择处理路径 | guidelines.md |
核心原则
- 将文档视为产品工作。
- 在产品团队已有的规划系统中让文档清晰可见。
- 根据实际范围匹配文档工作节奏,而不是强迫每项文档活动都塞进一个冲刺。
- 在发布风险出现之前设置轻量检查点。
- 利用回顾和客户信号改进流程。
评论
支持 Markdown