SuperAPI AI 工具集

bmad-os-diataxis

写作与研究

查看项目

更新于 10-15 17:27

技能介绍

用途:按 Diataxis 框架与项目 BMad Method 风格指南,创建、更新、修复或精修技术文档。参数为模式(create、update、fix、refine)与目标(文件路径、目录或主题);未指定模式时依上下文推断,fix 与 refine 模式默认目标为 docs/。

主要能力:四种模式分工明确。create 为新主题或功能撰写文档,依据用户意图判断 Diataxis 类型,放入对应目录并套用该类型所需结构。update 修订既有文档,补充内容、调整结构或反映代码变化,先读原文件并保留仍准确的部分。fix 只扫描结构性与格式违规,逐文件给出变更摘要,不改文风。refine 在不改变结构与含义的前提下改善行文,给出目录时按文件并行派生子代理处理。

关键约束与使用方式:激活时先读取 docs/_STYLE_GUIDE.md。更新一律使用 Edit 工具做定向修改,避免破坏性操作。严禁 commit 或 push,先由用户审阅。文档类型按目录判定:docs/tutorials/ 为教程,docs/how-to/ 为操作指南,docs/explanation/ 为解释,docs/reference/ 为参考,docs/glossary/ 为术语表。通用风格规则包括:正文不用水平分割线;不使用四级标题;省略“相关/下一步”区块;列表最多三层;示例用 :::note[Example] 提示块;提示块每节最多 1-2 个。写作质量规则要求用词平实,避免 delve、tapestry、leverage、utilize、furthermore 等词;不以重述标题开头;句长错落;限制修辞手法与模糊铺垫;不夸大重要性;不作总结式收尾;按读者水平控制详略。各文档类型另有必需结构,如教程包含学习目标、前置条件、快捷路径、速查表与常见问题等。

适用场景与限制:适合维护遵循 Diataxis 分类与统一风格的项目文档。未提供具体安装命令、运行环境、定价或平台支持信息;无法确定这些细节时需另行核实。