Skill 广场
Diátaxis技术文档编写 Skill

Diátaxis技术文档编写.Skill

@mcollina/documentation

4.7优秀AI 评分基础检查通过源自 GitHub

该能力专为开发者和技术写作者设计,遵循业界经典的 Diátaxis 文档架构体系。它能够识别用户的受众群体与文档意图,将混乱的技术材料解耦并重构为四种独立形态:面向新手的实践教程(Tutorials)、面向特定任务的操作指南(How-to guides)、供快速查阅的参数与API参考(Reference),以及阐述设计决策与底层概念的原理讲解(Explanation),有效避免教程夹带参考手册、操作步骤掺杂底层原理解释等常见文档痛点。

编程开源项目维护者后端与全栈软件工程师技术写作者(Technical Writer)2026-09-23 更新main

Diátaxis技术文档编写

该能力专为开发者和技术写作者设计,遵循业界经典的 Diátaxis 文档架构体系。它能够识别用户的受众群体与文档意图,将混乱的技术材料解耦并重构为四种独立形态:面向新手的实践教程(Tutorials)、面向特定任务的操作指南(How-to guides)、供快速查阅的参数与API参考(Reference),以及阐述设计决策与底层概念的原理讲解(Explanation),有效避免教程夹带参考手册、操作步骤掺杂底层原理解释等常见文档痛点。

它会先理解你的原始内容和目标,再按清晰的步骤完成处理。你不需要学习复杂命令,也不用理解背后的技术细节。

常见场景

它能帮你做什么?

01

02

03

三步完成

怎么使用

1安装 Skill

把右侧安装请求发给你的 AI。

2说清楚目标

告诉 AI 你想完成什么,或直接贴入内容。

3检查结果

按需要继续调整语气、范围或格式。

复制就能用

你可以直接这样说

请基于 Diátaxis 框架,为我们新开源的 CLI 部署工具编写一份'从零构建第一个项目'的新手教程。

我写了一段关于数据库连接池参数配置的文档,请将其拆分为纯参数查阅的 Reference 页和解释底层机制的 Explanation 页。

请帮我为现有的 FastAPI 项目编写一篇'如何将应用部署到 Kubernetes'的操作指南,假设读者已有基础 K8s 知识。

适用人群

适合谁?

开源项目维护者后端与全栈软件工程师技术写作者(Technical Writer)开发者体验(DevRel)专员

上手门槛

使用难度

进阶

需要了解任务流程,页面已整理好使用步骤。

兼容范围

支持哪些 AI?

Codex可直接使用
Claude Code可直接使用
OpenClaw可直接使用
Hermes可直接使用
国内 Agent可直接使用

中文用户增强

Skill Px 做了什么?

中文说明简化使用方式补充中文案例整理安装流程降低理解难度