SuperAPI AI 工具集

docs-writer

写作与研究

查看项目

更新于 10-15 08:24

技能介绍

Docs Writer 是一个面向产品与技术文档创建的技能,核心特点是通过引导式发现(guided discovery)来生成或更新文档。

用途

该技能用于创建多种产品和技术文档,覆盖从需求、设计到审计、定位和归档的完整文档生命周期。

主要能力

根据资料,Docs Writer 支持以下文档类型,每种类型对应一个指令文件:

  • PRD — 产品需求:prd.md
  • Feature PRD — 功能需求:feature-prd.md
  • Feature Design Doc — 功能技术设计:feature-design.md
  • Audit report — 对提供的审计输出进行汇总的发现报告:feature-audit.md
  • PRODUCT — 战略定位与身份:product.md
  • Design Doc — 精简技术设计与权衡:design.md
  • ADR — 单一架构决策记录:adr.md
  • Archive feature — 将功能文件夹移至冷存储:feature-archive.md

使用方式

工作流程如下:

  1. 触发(trigger)
  2. 识别文档类型(detect type)
  3. 加载指令(load instruction)
  4. 定位文档(locate document)
  5. 起草(drafting)

具体规则:

  • 从触发条件识别文档类型;如果类型不明确,询问用户。
  • 对于同时要求两种文档的功能请求,先加载 feature-prd.md,然后加载 feature-design.md。
  • 如果文档已存在,则更新请求的部分。
  • 如果文档不存在,则进行完整发现流程。
  • 对于 ADR,创建编号记录或更新请求的记录。
  • 归档操作:选择功能文件夹,移动到 .artifacts/archive/features/。

适用场景

适用于需要创建或维护产品需求、功能需求、技术设计、审计报告、产品定位、架构决策记录以及功能归档的团队或个人。

限制

资料中未提供关于收费、价格、平台支持、具体效果或详细使用步骤的更多信息,这些内容暂未提供。