⚡

Diataxis文档生成器 diataxis-doc-generator

Diataxis文档生成器是一款基于Diataxis框架的智能文档生成工具，专门为技术团队和开发者提供结构化、高质量的文档解决方案。它能够自动将API规范、源代码和开发需求转化为完整的文档体系，包括教程、操作指南、API参考和解释性内容，支持多平台集成和版本控制，显著提升文档质量和开发效率。关键词：文档生成、Diataxis框架、API文档、开发者文档、技术文档、自动化文档、文档工具、代码文档化

DevOps 0 次安装 0 次浏览 更新于 2/25/2026

name: diataxis-doc-generator description: 遵循Diataxis框架生成文档 allowed-tools:

  • Read
  • Write
  • Edit
  • Glob
  • Grep
  • Bash

Diataxis文档生成器技能

概述

本技能遵循Diataxis框架生成全面的文档，将内容组织为教程、操作指南、参考和解释类别，以实现最佳的开发者学习效果。

能力

  • 将文档结构化为教程、操作指南、参考、解释
  • 生成渐进式的入门指南
  • 创建交互式API参考文档
  • 构建多语言代码示例仓库
  • 实现文档版本控制
  • 配置搜索和导航
  • 从代码注释生成文档
  • 支持多种文档平台

目标流程

  • API文档系统
  • SDK入门和教程
  • 开发者体验优化

集成点

  • Docusaurus用于基于React的文档
  • ReadTheDocs用于Python项目
  • Mintlify用于现代文档
  • GitBook用于协作文档
  • MDX用于交互式组件

输入要求

  • API规范或源代码
  • 目标用户画像
  • 文档平台偏好
  • 品牌和样式指南
  • 代码示例要求

输出成果

  • 结构化文档站点
  • 教程序列
  • 操作指南集合
  • API参考页面
  • 解释性文章
  • 代码示例仓库
  • 导航配置

使用示例

skill:
  name: diataxis-doc-generator
  context:
    apiSpec: ./openapi.yaml
    platform: docusaurus
    languages:
      - javascript
      - python
      - curl
    includePlayground: true
    versioning: true

最佳实践

  1. 将面向学习的内容与面向任务的内容分开
  2. 保持教程专注于学习，而非完整性
  3. 使操作指南以目标为导向
  4. 确保参考准确且完整
  5. 编写解释以加深理解
  6. 包含可运行的代码示例