Diátaxis技术文档编写
基于Diátaxis框架将技术内容准确划分为新手教程、操作指南、参考规范或原理解释,产出结构清晰且符合工程标准的文档。
功能与用途
该能力专为开发者和技术写作者设计,遵循业界经典的 Diátaxis 文档架构体系。它能够识别用户的受众群体与文档意图,将混乱的技术材料解耦并重构为四种独立形态:面向新手的实践教程(Tutorials)、面向特定任务的操作指南(How-to guides)、供快速查阅的参数与API参考(Reference),以及阐述设计决策与底层概念的原理讲解(Explanation),有效避免教程夹带参考手册、操作步骤掺杂底层原理解释等常见文档痛点。
适用场景
- 新功能入门教程编写:针对初学者设计动手实践教程,按步骤输出可验证结果,避免穿插复杂理论,帮助用户零门槛完成首次构建体验。
- 工程任务操作指南撰写:面向具备基础的开发人员,针对特定实际问题(如对接鉴权、部署服务)梳理端到端实施步骤与前置条件。
- API与配置参考规范整理:以统一格式提取并整理配置参数、CLI命令或接口规格,注明数据类型、默认值与极简示例,便于快速检索事实。
- 存量混合技术文档重构:梳理内容混杂的旧文档,将交织的操作步骤、概念探讨与参数列表解耦拆分,建立标准分明的 Diátaxis 架构。
适用人群
- 开源项目维护者
- 后端与全栈软件工程师
- 技术写作者(Technical Writer)
- 开发者体验(DevRel)专员
使用步骤
- 提供目标技术功能、API 规范或现有需要重构的文档草稿
- 明确文档针对的受众角色及用户意图(学习新手体验、解决特定问题、查阅技术事实或理解核心原理)
- 根据 Diátaxis 对应的模板与结构规范生成独立类型的文档草稿,并完成可验证性检查
开始使用
将需求和 Skill 名称发送给已连接 SkillPX MCP 的 AI 助手,核对适用工具和安装要求。
技术信息
- 分类
- 编程
- 适用工具
- Codex、Claude Code、OpenClaw、Hermes、国内 Agent
- 使用难度
- 进阶
- 版本
- main
- 最近更新
- 2026-09-23
- 文件数
- 3
- 安装包大小
- 自动生成 ZIP
- 安全检查
- 基础检查通过
Creates, structures, and reviews technical documentation following the Diátaxis framework (tutorials, how-to guides, reference, and explanation pages). Use when a user needs to write or reorganize docs, structure a tutorial vs. a how-to guide, build reference docs or API documentation, create explanation pages, choose between Diátaxis documentation types, or improve existing documentation structure. Trigger terms include: documentation structure, Diátaxis, tutorials vs how-to guides, organize docs, user guide, reference docs, technical writing.
依赖与权限
- 读取用户主动提供的内容