◉ Pulse
JuanMarchetto avatar
#67 today ▼ 27

JuanMarchetto/doc-standards-skill

Python AI #agent-skills #claude-code #claude-skills #documentation

Claude Code skill: five-layer documentation quality standards (ASD-STE100, Google/Microsoft style, ISO 24495, AI readability) with a machine-checkable lint gate

Created Jul 22, 2026
Stars
8
Today
+1
Forks
1
Quality
100/100
Momentum
20

README

Fetched from GitHub on Oct 30, 2026, 11:04 PM UTC · README.md

View original on GitHub

Third-party content — Open Source Pulse is not the owner of this repository.

This README belongs to JuanMarchetto/doc-standards-skill and its contributors. We fetch it directly from the project’s public GitHub repository and display it for reference only. All text, code, images and trademarks remain the property of their respective authors. See the repository for its license terms. Copyright / takedown policy.

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?

An A/B test with two identical agents wrote a README for the same small CLI tool. The agent with the skill passed 6 of 6 assertions and produced 1 lint finding. The agent without it passed 3 of 6 and produced 6 findings — it placed the destructive-action warning after the command it protects, used a positional "as shown above" reference, and rotated between "argument", "flag", and "option". The eval prompts ship in evals/evals.json so you can rerun the comparison.

This README passes its own gate:

python3 doc-standards/scripts/check_docs.py README.md

License

MIT

Rendered by GitHub from the repository’s README. Scroll to read the full file.
First trending

Jul 23, 2026

first spotted on the list

Best rank

#34

highest position reached

Appearances

2

times on the trending list

Quality score

100

out of 100

Momentum

20

trend strength indicator

Star velocity

0.08

stars per day since creation

Activity — last 60 days

daily counts, collected every 6 hours
  • Stars
  • Forks
  • Merged PRs
  • Issues
  • Closed issues

Collecting activity data since launch — check back in a few days.

Star history

total stars per snapshot
6789JuanMarchetto/doc-standards-skill · Jul 23, 8 AM UTC: 7 starsJuanMarchetto/doc-standards-skill · Jul 23, 2 PM UTC: 8 stars8:35 AM11:22 AM2:09 PM

Rank history

position on trending · lower is better
#1#30#35#40#45#50#55#60#65#70Jul 23, 8 AM UTC: rank #34Jul 23, 2 PM UTC: rank #678:35 AM11:22 AM2:09 PM

3D card for your website

Live HTML card with a glass surface and pointer tilt. Paste the iframe on any website.

<iframe src="https://www.notionpulse.cc/embed/JuanMarchetto/doc-standards-skill" width="420" height="240" style="border:0;max-width:100%;background:transparent" loading="lazy" title="JuanMarchetto/doc-standards-skill — trending on Open Source Pulse"></iframe>

Stars badge

Show current stars in your README or profile. Auto-updates every 6 hours.

JuanMarchetto/doc-standards-skill stars badge
Markdown
[![JuanMarchetto/doc-standards-skill](https://www.notionpulse.cc/api/badge/JuanMarchetto/doc-standards-skill.svg)](https://www.notionpulse.cc/repo/JuanMarchetto/doc-standards-skill)
HTML
<a href="https://www.notionpulse.cc/repo/JuanMarchetto/doc-standards-skill"><img src="https://www.notionpulse.cc/api/badge/JuanMarchetto/doc-standards-skill.svg" alt="JuanMarchetto/doc-standards-skill stars badge" /></a>

Repository of the Day

#34 Repository of the Day

Repository of the Week

#34 Repository of the Week

Repository of the Month

#34 Repository of the Month