npx skills add https://github.com/mcollina/skills --skill documentation当你需要按照 Diátaxis 框架创建、审阅或改进技术文档时,请使用此技能。例如:
将文档组织成四种不同的类型——教程、操作指南、参考资料和解释说明——每种类型服务于不同的用户需求和场景。
在创建文档之前,务必询问澄清性问题,了解用户的背景、受众和目标。
根据用户信号使用以下决策检查表:
| 用户信号 | 文档类型 |
|---|---|
| "我是 X 的新手,想学习它" / "请带我一步步操作" | 教程 |
| "我如何…?" / "我需要完成 X" | 操作指南 |
| "X 的参数/选项/语法是什么?" | 参考资料 |
| "为什么 X 以这种方式工作?" / "帮助我理解 X" | 解释说明 |
快速决策树:
广告位招租
在这里展示您的产品或服务
触达数万 AI 开发者,精准高效
示例引言:
"在本教程中,你将使用 Express 构建一个简单的 REST API。最后,你将拥有一个能够响应 GET 请求的运行中的服务器。无需事先具备 Express 经验。"
示例引言:
"本指南展示了如何为现有的 Express 应用添加 JWT 身份验证。假设你已有一个可运行的 Express 服务器,并对中间件有基本了解。"
示例条目:
timeout(整数, 默认值:5000) 请求失败前等待响应的最长时间(毫秒)。示例:{ timeout: 3000 }
示例引言:
"身份验证和授权经常被混淆。本页解释了二者的区别、为何两者都很重要,以及常见模式(会话、令牌、OAuth)如何以不同方式处理每个问题。"
| 类型 | 验证检查 |
|---|---|
| 教程 | 初学者能否在没有外部帮助的情况下从头到尾完成它? |
| 操作指南 | 它是否为有经验的用户解决了所述问题? |
| 参考资料 | 用户能否在 30 秒内找到特定事实? |
| 解释说明 | 用户是否理解了为什么,而不仅仅是是什么? |
每周安装量
399
代码仓库
GitHub 星标数
1.6K
首次出现
Jan 31, 2026
安全审计
安装于
github-copilot388
codex388
opencode388
gemini-cli383
cursor382
kimi-cli381
Use this skill when you need to create, review, or improve technical documentation following the Diátaxis framework. Examples include:
Organize documentation into four distinct types — tutorials, how-to guides, reference material, and explanations — each serving different user needs and contexts.
Always ask clarifying questions about the user's context, audience, and goals before creating documentation.
Use the following decision checklist based on user signals:
| User signal | Documentation type |
|---|---|
| "I'm new to X and want to learn it" / "walk me through" | Tutorial |
| "How do I…?" / "I need to accomplish X" | How-to guide |
| "What are the parameters/options/syntax for X?" | Reference |
| "Why does X work this way?" / "Help me understand X" | Explanation |
Quick decision tree:
Example intro:
"In this tutorial, you will build a simple REST API using Express. By the end, you will have a running server that responds to GET requests. No prior Express experience is needed."
Example intro:
"This guide shows how to add JWT authentication to an existing Express app. It assumes you have a working Express server and basic familiarity with middleware."
Example entry:
timeout(integer, default:5000) Maximum time in milliseconds to wait for a response before the request fails. Example:{ timeout: 3000 }
Example intro:
"Authentication and authorisation are often confused. This page explains the distinction, why both matter, and how common patterns (sessions, tokens, OAuth) approach each concern differently."
| Type | Validation check |
|---|---|
| Tutorial | Can a beginner complete it end-to-end without external help? |
| How-to guide | Does it solve the stated problem for an experienced user? |
| Reference | Can the user find a specific fact in under 30 seconds? |
| Explanation | Does the user understand the why , not just the what? |
Weekly Installs
399
Repository
GitHub Stars
1.6K
First Seen
Jan 31, 2026
Security Audits
Gen Agent Trust HubPassSocketPassSnykPass
Installed on
github-copilot388
codex388
opencode388
gemini-cli383
cursor382
kimi-cli381
新闻稿撰写工具:使用 inference.sh CLI 进行事实核查与专业新闻稿创作
7,400 周安装