·docs-writing
""

docs-writing

mblode/agent-skills

使用 Diataxis、Stripe 风格的清晰度和八项规则编写和审核技术文档。跨越 9 个类别的 52 条规则,涵盖语音、结构、清晰度、代码示例、格式、导航、可扫描性、内容卫生和审查。在编写文档、创建自述文件、记录 API、编写教程、构建文档网站或审核文档质量时使用。

11安装·4热度·@mblode

安装

$npx skills add https://github.com/mblode/agent-skills --skill docs-writing

SKILL.md

52 rules across 9 categories for documentation quality. Focuses on concrete issues with concrete fixes.

| Priority | Category | Impact | Prefix | Rules |

| 1 | Voice & Tone | CRITICAL | voice- | 4 | | 2 | Structure & Organization | CRITICAL | structure- | 10 | | 3 | Clarity & Language | HIGH | clarity- | 6 | | 4 | Code Examples | HIGH | code- | 7 | | 5 | Formatting & Syntax | MEDIUM-HIGH | format- | 8 | | 6 | Navigation & Linking | MEDIUM-HIGH | nav- | 6 |

使用 Diataxis、Stripe 风格的清晰度和八项规则编写和审核技术文档。跨越 9 个类别的 52 条规则,涵盖语音、结构、清晰度、代码示例、格式、导航、可扫描性、内容卫生和审查。在编写文档、创建自述文件、记录 API、编写教程、构建文档网站或审核文档质量时使用。 来源:mblode/agent-skills。

查看原文

可引用信息

为搜索与 AI 引用准备的稳定字段与命令。

安装命令
npx skills add https://github.com/mblode/agent-skills --skill docs-writing
分类
""沟通写作
认证
收录时间
2026-02-17
更新时间
2026-02-18

快速解答

什么是 docs-writing?

使用 Diataxis、Stripe 风格的清晰度和八项规则编写和审核技术文档。跨越 9 个类别的 52 条规则,涵盖语音、结构、清晰度、代码示例、格式、导航、可扫描性、内容卫生和审查。在编写文档、创建自述文件、记录 API、编写教程、构建文档网站或审核文档质量时使用。 来源:mblode/agent-skills。

如何安装 docs-writing?

打开你的终端或命令行工具(如 Terminal、iTerm、Windows Terminal 等) 复制并运行以下命令:npx skills add https://github.com/mblode/agent-skills --skill docs-writing 安装完成后,技能将自动配置到你的 AI 编程环境中,可以在 Claude Code 或 Cursor 中使用

这个 Skill 的源码在哪?

https://github.com/mblode/agent-skills