SuperAPI AI 工具集

doc-writer

写作与研究

查看项目

更新于 10-16 02:01

技能介绍

Doc Writer 是一个用于创建技术文档的技能,目标是把文档组织到项目 /docs 目录下的正确结构中。

用途 该技能用于创建有组织的技术文档,涵盖规格说明(specs)、实施计划(plans de implementación)、架构决策记录(ADRs)以及参考文档(documentación de referencia)。当需要为项目撰写上述类型文档时启用。

主要能力

  • 检查项目中是否已存在 docs/ 及其子文件夹。
  • 根据现有子文件夹提供类别选项;若不存在子文件夹,则向用户询问类别。
  • 按规则生成文件名。
  • 读取并套用 references/ 中对应的模板来创建文档。
  • 在需要时创建缺失的子文件夹。

使用方式 创建过程分为四步:

第 1 步:查找已有的 docs 结构 检查是否存在 docs/ 及其子文件夹。

第 2 步:确定类别 如果 docs/ 中已有子文件夹,则将其作为选项提供。 如果没有子文件夹,则询问用户。可选类别及用途如下:

  • specs/:功能/系统的规格说明
  • planning/:进行中的实施计划
  • archive/:已完成或被取代的文档
  • architecture/:ADRs、架构决策
  • reference/:技术参考文档
  • backlog/:待办功能、未来想法
  • work-in-progress/:进行中工作的文档

第 3 步:生成文件名 格式为 YYYY-MM-DD-<feature-name>.md。 使用当前日期(不含时间)。 <feature-name> 使用 kebab-case,具有描述性,不含空格。 例外:ADR 使用 NNNN-<name>.md(顺序编号)。

第 4 步:创建文档 若子文件夹不存在则创建。 读取并套用 references/ 中对应的模板:

  • Spec:references/spec-template.md
  • Plan:references/plan-template.md
  • ADR:references/adr-template.md
  • Reference:references/reference-template.md 将文件写入正确位置。

资源 如需查看每种文档类型的完整示例,可阅读 references/ 中的文件:

  • Spec:模板 references/spec-template.md,示例 references/spec-example.md
  • Plan:模板 references/plan-template.md,示例 references/plan-example.md
  • ADR:模板 references/adr-template.md,示例 references/adr-example.md
  • Reference:模板 references/reference-template.md,示例 references/reference-example.md

适用场景 适用于需要在项目 /docs 目录下按统一结构创建规格说明、实施计划、架构决策记录或参考文档的场景。

限制 资料中未提供关于收费、价格、平台支持范围、具体效果或更多使用限制的信息。