用途
Diataxis 文档生成器用于按照 Diataxis 框架生成文档，将内容划分为教程（tutorials）、操作指南（how-to guides）、参考（reference）和解释（explanation）四类，以优化开发者的学习体验。它适合需要系统化组织技术文档的团队，尤其是围绕 API、SDK 和开发者工具构建文档的场景。
主要能力
- 按 Diataxis 框架将文档结构化为教程、操作指南、参考和解释四类。
- 生成渐进式的入门指南。
- 创建交互式 API 参考文档。
- 构建包含多种语言的代码示例仓库。
- 实现文档版本管理。
- 配置搜索与导航。
- 从代码注释生成文档。
- 支持多种文档平台。
使用方式
该技能通过配置上下文来使用。示例配置如下：
skill:
name: diataxis-doc-generator
context:
apiSpec: ./openapi.yaml
platform: docusaurus
languages:
- javascript
- python
- curl
includePlayground: true
versioning: true
输入要求包括：API 规范或源代码、目标读者画像、文档平台偏好、品牌与风格指南、代码示例要求。
输出产物包括：结构化文档站点、教程序列、操作指南集合、API 参考页面、解释文章、代码示例仓库、导航配置。
适用场景
- API 文档系统
- SDK 入门与教程
- 开发者体验优化
集成点包括：Docusaurus（基于 React 的文档）、ReadTheDocs（Python 项目）、Mintlify（现代文档）、GitBook（协作文档）、MDX（交互式组件）。
最佳实践
- 将面向学习的内容与面向任务的内容分开。
- 让教程专注于学习，而非完整性。
- 让操作指南以目标为导向。
- 确保参考内容准确且完整。
- 撰写解释以加深理解。
- 包含可运行的代码示例。
限制
资料中未提供关于收费、价格、平台限制、具体效果或详细使用步骤的更多信息。