Token导航 LogoToken导航TokenDH.com
AI 工具需要联网github未标认证来源可访问clear审计提醒

devdocs-requirements开发文档要求

Agent Skill

devdocs-requirements 用于处理 GitHub 仓库、Issue、Pull Request 和代码协作信息,适合在 Codex、Claude、Cursor、Gemini CLI 中需要围绕仓库状态、代码变更或协作事项进行整理时使用。可结合来源仓库、安装命令和原始 README 继续核验具体用法。安装前建议确认权限范围、维护状态,以及是否会触发联网、命令执行或文件读写。

总安装

838

周安装

36

GitHub Stars

公开资料未说明

下载量

294
CodexClaudeCursorGemini CLI

安装说明

本站只整理中文说明和来源信息,不托管安装包,也不代用户安装。

GitHub

来源数

3

许可证

MIT

最后核验

2026-05-01

来源状态

来源可访问

安装方式

通过对话安装

复制提示词发给支持本地命令或 Skills 的 AI 助手,先确认命令和权限,再让它执行。

请帮我安装这个 Agent Skill:devdocs-requirements(开发文档要求)
来源仓库:https://github.com/ab300819/skills
仓库路径:skills/devdocs-requirements
安装命令:
npx skills add https://github.com/ab300819/skills --skill devdocs-requirements
安装前请先检查当前环境是否支持对应 CLI,并向我确认将要执行的命令、安装目录、联网范围和文件读写权限;确认后再执行。

命令行安装

复制命令到本机终端执行。不同来源提供的安装方式可能略有差异;本站展示可直接复制的安装命令,安装前请核对来源页面。

skills.shnpx skills
npx skills add https://github.com/ab300819/skills --skill devdocs-requirements

简介

devdocs-requirements 将简短需求扩展为结构化 PRD,建立功能点与验收标准的关联。

  • 支持从零创建、增量追加背景信息或跳过计划直接生成文档。
  • 自动识别技术栈与约束条件,输出中文格式的需求文档。
  • 常用于新功能启动、PRD 编写或 retrofit 后补充项目背景。
  • 适用宿主包括 Codex、Claude、Cursor、Gemini CLI,接入前应确认版本、权限和运行环境要求。

SKILL.md

需求扩写

将用户简短需求扩展为结构化的需求文档,建立功能点、用户故事、验收标准的关联体系。

语言规则

  • 支持中英文提问
  • 统一中文回复
  • 使用中文生成文档

触发条件

  • 用户提供功能需求或想法
  • 用户要求创建/编写 PRD
  • 用户想要澄清或记录需求
  • 来自 /devdocs-feature 的增量需求委托
  • 用户需要补充项目背景信息(尤其是 retrofit 后)
  • 用户提供参考资料、领域知识、技术约束

运行模式

/devdocs-requirements              → 自动检测模式
/devdocs-requirements --incremental → 强制增量模式(追加功能点)
/devdocs-requirements --context     → 背景信息模式(追加/更新背景)
/devdocs-requirements --fast        → 跳过 Plan 模式,直接生成,仅最终确认
模式触发条件说明
初始模式01-requirements.md从零创建需求文档
增量模式已有 01-requirements.md扫描编号 + 追加功能点/用户故事/验收标准
背景信息模式--context 或用户要补充背景追加/更新"背景与目标"章节

--fast 模式

--fast 可与任意模式组合,行为变更:

  • 跳过 EnterPlanMode 步骤(初始模式)
  • 使用合理默认值(不询问技术栈偏好等)
  • 仅保留最终写入前的 1 次确认
  • 默认行为不变,--fast 是 opt-in

工作流程

初始模式

1. 收集原始需求
   │
   ├── 记录用户原话或关键表述
   ├── 标记来源(口述/邮件/Issue/会议纪要)
   └── 记录日期
   │
   ▼
2. 理解需求 + 探索代码库(如适用)
   │
   ▼
3. 进入 Plan 模式 → 呈现需求拆解方案
   │              (功能点划分、边界范围、优先级)
   ▼
4. 用户审批 Plan → 确认拆解方向或调整
   │
   ▼
5. 退出 Plan 模式 → 生成需求文档:识别功能点 (F-XXX)
   │
   ▼
6. 文档编写:用户故事 (US-XXX)
   │
   ▼
7. 文档编写:验收标准 (AC-XXX)
   │
   ▼
8. 生成追溯矩阵
   │
   ▼
9. 用户确认

增量模式

1. 扫描现有编号
   │
   ├── 读取 01-requirements.md
   └── 获取 F/US/AC 最大编号
   │
   ▼
2. 收集新增原始需求
   │
   ├── 记录用户原话,追加到 `## 0. 原始需求` 表格
   └── 若该章节不存在(历史文档),标注"缺失历史原始需求"后继续
   │
   ▼
3. 理解新增需求
   │
   ▼
4. 追加功能点/用户故事/验收标准
   │
   ├── 延续现有编号
   └── 标注增量版本和日期
   │
   ▼
5. 更新追溯矩阵
   │
   ▼
6. 用户确认
   │
   ▼
7. 返回新增编号列表(供调用方使用)

背景信息模式

1. 读取现有文档
   │
   ├── 检查 01-requirements.md 是否存在
   └── 提取现有"背景与目标"章节内容
   │
   ▼
2. 收集背景信息
   │
   ├── 引导用户提供信息(AskUserQuestion)
   ├── 接收用户直接输入
   ├── 从文件路径提取(Read)
   └── 从 URL 提取摘要(WebFetch)
   │
   ▼
3. 整合信息
   │
   ├── 合并到"背景与目标"章节
   ├── 补充到"技术约束"子章节
   └── 补充到"参考资料"子章节
   │
   ▼
4. 更新文档
   │
   ▼
5. 用户确认

上下文管理

分批原则

按功能点 (F-XXX) 分批扩写,每批完成一个功能点的全部用户故事和验收标准。

质量锚点

  • 首个功能点的 US/AC 作为质量锚点
  • 每个新功能点开始前,回顾首批的详细程度(US 的角色/期望/目的具体性、AC 的可量化程度、GWT 格式完整性)
  • 若当前批次详细程度明显低于锚点,立即补充

一致性自检

每个功能点扩写完成后,对比检查:

  • US 格式是否与首批一致(角色/期望/目的三要素完整)
  • AC 是否可量化可验证(非"系统应正常工作"等模糊描述)
  • 每个 US 是否有 2-3 条 AC(覆盖密度一致)

Plan 模式规范

仅初始模式使用 Plan 模式。增量模式和背景信息模式方向明确,无需 Plan。

初始模式 Plan 内容

在理解需求和探索代码后,必须使用 EnterPlanMode 呈现需求拆解方案

## 需求拆解方案

### 功能点划分
| 编号 | 功能点 | 描述 | 优先级 |
|------|--------|------|--------|
| F-001 | ... | ... | P0 |
| F-002 | ... | ... | P1 |

### 范围边界
- 包含:<本次范围内的功能>
- 排除:<明确不做的功能>

### 关键决策
- <需要用户确认的拆解决策>

### 预估规模
- 功能点数量:X 个
- 用户故事数量:约 Y 个
- 验收标准数量:约 Z 个

Plan 模式时机

模式是否使用 Plan理由
初始模式F 编号一旦确立,下游全部引用,改动成本高
增量模式追加方向明确,编号延续现有体系
背景信息模式信息整合,无架构决策

编号规范

类型前缀格式示例
功能点FF-XXXF-001, F-002
用户故事USUS-XXXUS-001, US-002
验收标准ACAC-XXXAC-001, AC-002

编号规则

  • 全局顺序编号,不嵌套
  • 通过追溯矩阵表达关联关系
  • 编号一旦分配不可复用

输出文件

主文件docs/devdocs/01-requirements.md

如文档超过 300 行,可拆分为:

  • 01-requirements.md - 概览和功能点
  • 01-requirements-stories.md - 用户故事详情
  • 01-requirements-nfr.md - 非功能性需求

详细模板参见 templates/requirements-template.md

文档结构

# 需求文档:<功能名称>

## 0. 原始需求
## 1. 背景与目标
## 2. 功能点清单
## 3. 用户故事
## 4. 验收标准
## 5. 追溯矩阵
## 6. 非功能性需求
## 7. 范围边界
## 8. 风险与假设
## 0. 原始需求 记录用户原话或关键表述,作为需求精化的基准参照。详见模板。

核心概念

  • 功能点 (F-XXX):用户可感知的独立功能单元,可独立交付和验证
  • 用户故事 (US-XXX):格式 "作为 <角色>,我希望 <功能>,以便 <价值>"
  • 验收标准 (AC-XXX):可量化、可验证的完成条件,每个 US 至少 2-3 条
  • 追溯矩阵:展示 F → US → AC 的关联关系

详细格式和示例参见 templates/requirements-template.md

增量模式详解

编号扫描

从现有文档提取最大编号:

## 当前状态

| 类型 | 当前最大编号 | 下一编号 |
|------|-------------|----------|
| 功能点 (F) | F-003 | F-004 |
| 用户故事 (US) | US-008 | US-009 |
| 验收标准 (AC) | AC-015 | AC-016 |

追加格式

---

## 功能迭代 v2: <功能名称> (2024-01-15)

> 本次新增 F-004,包含 2 个用户故事、5 个验收标准。

### F-004: <功能名称>

**描述**:<功能描述>

**用户故事**:

| 编号 | 角色 | 期望 | 目的 |
|------|------|------|------|
| US-009 | 作为<角色> | 我希望<功能> | 以便于<价值> |

**验收标准**:

- [ ] AC-016: <标准1>
- [ ] AC-017: <标准2>

返回值

增量模式完成后,返回新增编号列表供调用方使用:

新增编号:
- F-004
- US-009, US-010
- AC-016 ~ AC-020

背景信息模式详解

进入 --context 模式时,必须读取 context-mode.md 获取信息收集引导、输入方式和文档结构模板。

约束

阶段边界约束(最高优先级)

  • 本 Skill 仅产出文档,严禁编写或生成任何实现代码(源代码、脚本、配置变更)
  • Write 工具仅用于写入 docs/devdocs/ 下的 Markdown 文档
  • 退出 Plan 模式后,执行文档编写(非代码实现)
  • 编码实现由 /devdocs-dev-workflow 负责,本 Skill 不涉及

功能点约束

  • 每个功能点必须有唯一编号 (F-XXX)
  • 功能点必须标注优先级 (P0/P1/P2)
  • 功能点描述应简洁明确

用户故事约束

  • 每个用户故事必须关联到功能点
  • 必须遵循"作为...我希望...以便..."格式
  • 每个功能点至少有 1 个用户故事

用户故事质量检查 (INVEST)

生成时自动验证,无需额外用户交互:

  • Independent:可独立交付
  • Negotiable:可协商细节
  • Valuable:对用户有价值
  • Estimable:可估算工作量
  • Small:一次迭代可完成
  • Testable:可通过测试验证

验收标准约束

  • 每个验收标准必须有唯一编号 (AC-XXX)
  • 每个用户故事至少有 2 条验收标准
  • 验收标准必须可量化、可验证
  • 必须描述验证方式

格式选项

  • 表格格式(默认):适合简单条件
  • Given-When-Then:适合复杂行为场景

- Given <前置条件> - When <操作> - Then <预期结果>

追溯约束

  • 必须提供追溯矩阵
  • 所有功能点必须有对应的用户故事
  • 所有用户故事必须有对应的验收标准

增量模式约束

  • 必须先扫描现有编号,延续编号
  • 追加内容必须标注增量版本和日期
  • 不得删除或覆盖现有内容
  • 完成后必须返回新增编号列表

原始需求约束

  • 初始模式:必须在 F/US/AC 精化前收集原始需求,写入 ## 0. 原始需求
  • 增量模式:新增需求必须追加到 ## 0. 原始需求 表格
  • 背景信息模式(--context):不写入 ## 0. 原始需求——除非用户提供的是需求原话而非背景补充
  • 原始需求应保留原话或最小必要改写
  • 历史文档若无该章节,标注"缺失历史原始需求"后继续

背景信息模式约束

  • 必须先读取现有"背景与目标"章节内容
  • 不得删除或覆盖现有背景信息
  • 新增内容必须标注更新日期
  • URL 引用必须使用 WebFetch 提取摘要,不能仅记录链接
  • 文件引用必须使用 Read 验证文件存在
  • 敏感信息(密钥、密码、内部 URL)不得写入文档
  • 参考资料必须注明用途和关联性

Plan 模式约束

  • 初始模式:理解需求 + 探索代码后,必须进入 Plan 模式
  • Plan 必须包含功能点划分和范围边界
  • 用户审批 Plan 后才能开始编号分配和文档写入
  • 用户要求调整时,更新 Plan 后重新审批
  • 增量模式和背景信息模式不使用 Plan 模式

确认约束

  • 必须与用户确认功能点是否完整
  • 不得添加用户未提及且未确认的功能

上下文管理约束

  • 后批次 US/AC 详细程度不低于首批次(格式完整性、量化程度、覆盖密度)
  • 每个功能点完成后执行一致性自检

Skill 协作

场景协作 Skill说明
新功能需求/devdocs-feature被调用:新功能触发需求追加
洞察转化/devdocs-insights被调用:改进建议转化为需求
Bug 暴露需求/devdocs-bugfix被调用:Bug 修复发现需求缺失
项目改造/devdocs-retrofit被调用:逆向推导生成需求
改造后补充背景/devdocs-retrofit后续:逆向完成后用 --context 补充背景
设计阶段/devdocs-system-design后续:需求确认后进入设计
上下文生成/devdocs-onboard后续:背景信息会被提取到上下文摘要

子 Agent 摘要格式

当本 Skill 作为子 Agent 运行时,返回以下结构化摘要:

skill: devdocs-requirements
mode: initial | incremental
new_ids:
  features: [F-001~F-003]
  stories: [US-001~US-008]
  acceptance: [AC-001~AC-015]
status: completed
output_files:
  - docs/devdocs/01-requirements.md

下一步

完成模式建议下一步
初始模式/devdocs-system-design 进入系统设计
增量模式/devdocs-system-design 增量设计或 /devdocs-test-cases 补充测试
背景信息模式继续 /devdocs-requirements 定义功能点,或 /devdocs-system-design 设计
提示:文档变更较大时,建议运行 /agent-memory 同步记忆文件。

适合场景

01

用户想查找某类 Agent Skill 时

02

需要根据任务场景推荐可安装能力包时

03

需要对比不同来源的安装命令和来源信息时

04

需要参考平台分布和安装热度时

能力概览

能力 1

按任务关键词查找相关 Skills

能力 2

展示可复制的安装命令

能力 3

保留来源站点、仓库和原始说明,方便继续核验

能力 4

补充不同宿主或平台的使用分布数据

能力 5

展示第三方安全扫描或审计结果

安装后应在对应宿主中按原始 README 的触发条件使用;具体调用方式请以来源页面和 README 为准。

平台分布

Claude Code

28.12%
按下载量换算83

Antigravity

24.81%
按下载量换算73

OpenCode

20.13%
按下载量换算59

Gemini CLI

14.24%
按下载量换算42

windsurf

8.47%
按下载量换算25

Codex

3.14%
按下载量换算9

安全审计

Gen Agent Trust Hub

通过

Socket

通过

Snyk

可疑

权限和风险

需要联网

该 Skill 可能需要联网访问来源站点、仓库或外部 API;具体网络访问范围需要结合源码和 README 复核。

安装前确认

本站仅展示第三方公开信息,不托管安装包,不提供自动安装或运行环境。安装前应自行审查源码、依赖和命令行为。来源安全扫描存在 warning/failed 结果,不能写成本站确认安全。

来源信息

继续浏览同类 Skills