SuperAPI AI 工具集

scaffold-docs

写作与研究

查看项目

更新于 10-15 20:34

技能介绍

用途:为代码库编写技术文档,采用自上而下、逐层迭代的工作流,每一层都需用户审核。文档写作被视为写作的子集,文字质量也在范围内,不只是结构。

主要能力:核心原则包括面向特定读者(主读者决定后续所有选择)、先建立心智模型、按读者目标而非包结构组织内容、解释设计决策的原因、只呈现读者需要的依赖、渐进式披露、迭代而非一次成型、清晰但不枯燥。输出分三类:Getting Started(getting-started.md,一个端到端教程)、Diving Deeper(diving-deeper/<topic>.md,每主题一文件)、Reference(reference/<module>.md,每模块一文件,接近纯 API 规范)。另有元数据文件 .scaffold-docs.yml 记录读者、上次同步的 git SHA 和 ask_audience 标志。

使用方式:工作流分五个阶段。阶段1发现与整体结构;阶段2分三遍构建 Getting Started(A:标题+学习要点+代码块;B:子标题+段落主题句;C:完整段落);阶段3构建每个选定的 Diving Deeper 主题;阶段4构建 Reference;阶段5在代码变更后更新现有文档。每个阶段文件位于 phases/ 下,只加载当前阶段。更新已有文档时从阶段5开始。阶段之间可清空上下文,磁盘产物作为持久交接。references/ 下文件按需加载,包括 audience-check.md、diving-deeper-heuristics.md、headline-style.md、prose-style.md。执行规则:保存文件时始终显示路径;不跳过检查点;修复当前遍时不写下一遍;阶段较大时建议分批;不要把代码转述成散文。

适用场景:需要为代码库系统化编写或更新技术文档时。

限制:资料未提供具体安装命令、收费、价格、平台或效果信息。