SuperAPI AI 工具集

draft-docs

写作与研究

查看项目

更新于 10-15 21:39

技能介绍

用途:draft-docs 根据代码库分析生成技术文档初稿,先输出到 docs/drafts/ 供审阅,避免直接写入正式文档位置;审阅完成后可将草稿发布到最终目录并更新导航配置。

主要能力:支持四种 Diátaxis 文档类型——Tutorial(学习)、How-To(任务)、Reference(信息)、Explanation(理解),通过提示词关键词和类型判定问题选择类型。生成前会先执行命令收集上下文,包括查看 docs/ 结构、识别文档框架(如 navigation.json、mint.json、docusaurus.config.js、mkdocs.yml)、检查已有草稿、获取近期代码改动,然后搜索代码库中的符号、文件与使用示例,生成包含 frontmatter 的文档草稿。

使用方式:生成草稿时调用技能并给出主题提示,例如 draft-docs "Document the authentication middleware";输出路径为 docs/drafts/{slug}.md,必要时先用 mkdir -p docs/drafts 创建目录。发布时使用 --publish 参数,例如 draft-docs --publish docs/drafts/websocket-api.md,然后按提示选择目标位置(Tutorials、API Reference、Guides、How-To、Concepts/Explanation 或自定义路径),执行 mv 移动文件,并在存在 docs/navigation.json 时添加页面条目,最后做文件存在性、导航包含和 markdownlint 等验证。

适用场景:为项目生成教程、操作指南、API 参考或概念说明的初稿,尤其适合已有 docs/ 目录和导航配置、需要从代码提取准确示例的场景。

限制:每次生成都必须加载 docs-style 及对应类型技能,草稿只能生成到 docs/drafts/,不能直接写到最终位置;必须包含 title 和 description 的 frontmatter;使用真实代码示例;发布时保留现有导航结构;覆盖已有文件前需要询问用户。官方未提供收费、价格或平台信息。