JD

juanmarchetto/doc-standards-skill

开发工具

本页由 AI 翻译,技术细节请以原文为准。 查看原文

20 stars 质量 54 趋势 14MIT

Claude 代码技能:五层文档质量标准(ASD-STE100、Google/Microsoft风格、ISO 24495、AI可读性),配备机器检测的棉絮门

概览

一项Claude代码技能,能让文档达到专业写作标准——并用“lint gate”来证明这一点。 由大型语言模型编写的文档有一种气味:同义词轮换、从属从句、填充、对冲。这项技能消除了专业文档系统已有的限制。这个想法起源于@dcoderio关于ASD-STE100的帖子,随后发展成五层标准堆栈。 把doc-standards文件夹复制到你的技能目录里: Claude Code 会自动识别。技能会在“写文档”、“文档化”、“改进 README”或“文档闻到AI写的气味”等请求时触发。 check_docs.py只需要Python 3。它检查句子长度、被动语态、禁用词、术语漂移、标题层级和相对链接完整性: 当你安装 Vale 并向项目添加.vale.ini时,脚本会将样式检查推迟给 Vale,只保留结构检查。

概述(AI 翻译)

一个让文档通过的Claude代码技能 专业写作标准——并用棉絮门来证明这一点。

LLM编写的文档有一种气味:同义词循环,从属从句, 填充,对冲。这项技能通过专业文档的限制将其移除 系统已经使用了。这个想法从 @dcoderio关于的一篇帖子 ASD-STE100,随后发展成五层标准堆栈。

五层

图层 它回答的问题 来源标准
1. 结构 我写的是哪份文件,是为谁写的? Diátaxis + ISO 24495-1
2. 受控语言 每句话都清晰吗? ASD-STE100
3. House风格 这符合开发者文档的惯例吗? Google / Microsoft 风格指南
4. AI可读性 代理能单独检索并使用每个部分吗? llms.txt + 检索实践
5. 验证 机器能否强制执行第2–4层? Vale 或捆绑检查器

安装

把doc-standards文件夹复制到你的技能目录里:

Claude Code 会自动拾取。该技能在以下请求时触发

本页由 AI 翻译,技术细节请以原文为准。

README

以下为原文 README 节选,完整内容请查看原文。

doc-standards

A Claude Code skill that makes documentation pass professional writing standards — and proves it with a lint gate.

Documentation written by an LLM has a smell: synonym rotation, subordinate clauses, filler, hedging. This skill removes it with the constraints professional documentation systems already use. The idea started from a post by @dcoderio about ASD-STE100, then grew into a five-layer criteria stack.

The five layers

Layer Question it answers Source standard
1. Structure Which document am I writing, for whom? Diátaxis + ISO 24495-1
2. Controlled language Is each sentence unambiguous? ASD-STE100
3. House style Is it consistent with developer-docs convention? Google / Microsoft style guides
4. AI readability Can an agent retrieve and use each section alone? llms.txt + retrieval practice
5. Verification Can a machine enforce layers 2–4? Vale or the bundled checker

Install

Copy the doc-standards folder into your skills directory:

cp -r doc-standards ~/.claude/skills/doc-standards

Claude Code picks it up automatically. The skill triggers on requests such as “write docs”, “document this”, “improve the README”, or “the docs smell AI-written”.

What is inside

doc-standards/
├── SKILL.md                      # workflow: structure → draft → style → AI pass → gate
├── references/
│   ├── ste100.md                 # ASD-STE100 digest: word, sentence, and safety-text rules
│   ├── style-guides.md           # Google + Microsoft house-style digest
│   ├── ai-readability.md         # self-contained sections, llms.txt format
│   └── vale-setup.md             # Vale install, per-project config, CI
├── scripts/
│   └── check_docs.py             # zero-dependency lint gate
└── evals/
    └── evals.json                # test prompts for the skill-creator eval loop

The lint gate

check_docs.py needs only Python 3. It checks sentence length, passive voice, banned words, terminology drift, heading hierarchy, and relative-link integrity:

python3 doc-standards/scripts/check_docs.py docs/

When you install Vale and add a .vale.ini to the project, the script defers its style checks to Vale and keeps only the structural checks. The exit code is 1 when any error-level finding exists, so the gate drops into CI as-is.

Terminology drift is the check that catches the strongest LLM tell. When a document uses “verify”, “check”, and “confirm” interchangeably, the gate reports it and the skill prescribes the fix: a terminology table with one approved term per concept.

Does it work?

在 GitHub 查看完整 README

推荐工具

换一个关键词,或者移除筛选条件。

安装

npx skillfish add juanmarchetto/doc-standards-skill
新手?先看 mcpskill.org 教程 →