mcpField
D
docs-writer

docs-writer

github.com/adeonir文档处理8165 次安装今天更新
代码仓库

关于 docs-writer

用于编写多类产品与技术文档的技能,可为 PRD、设计文档、ADR、审计报告和功能归档选择相应指引。文档已存在时更新指定部分,缺失时开展需求梳理。

主要功能

  1. 01按文档类型分流请求
  2. 02加载对应写作指引
  3. 03更新现有文档的指定部分
  4. 04为新文档开展需求梳理
  5. 05归档功能文件夹

适用场景

  1. 01起草产品需求文档
  2. 02编写技术设计或 ADR
  3. 03汇总审计发现
  4. 04将已完成的功能移入冷存储

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/adeonir/agent-skills --skill docs-writer

安装后在 Claude Code 中输入/docs-writer确认已加载。

包含的文件

除 SKILL.md 外,安装时一起下载的参考资料和脚本。

README.md
agents/
openai.yaml
assets/
adr.template.md
design-doc.template.md
feature-audit.template.md
feature-design.template.md
feature-prd.template.md
prd.template.md
product.template.md
instructions/
adr.md
design.md
feature-archive.md
feature-audit.md
feature-design.md
feature-prd.md
prd.md
product.md
references/
discovery.md
feature-document.md
quality.md
reconcile.md
tracker-document.md

详细介绍

文档撰写器

触发条件

类型加载
PRD — 产品需求prd.md
功能 PRD — 功能需求feature-prd.md
功能设计文档 — 功能技术设计feature-design.md
审计报告 — 汇总提供的审计输出中的发现feature-audit.md
PRODUCT — 战略定位与产品身份product.md
设计文档 — 精简的技术设计与权衡design.md
ADR — 单条架构决策记录adr.md
归档功能 — 将功能文件夹移至冷存储feature-archive.md

根据触发条件识别文档类型。如果存在歧义,请询问用户。

对于同时要求提供两份文档的功能请求,先加载 feature-prd.md,再加载 feature-design.md。

工作流

trigger → detect type → load instruction → locate document → drafting
  document exists → update the requested parts
  document absent → full discovery
  ADR → create a numbered record or update the requested record

archive → select feature folders → move to .artifacts/archive/features/

评论

支持 Markdown