docs-writing SKILL.md skillA

docs-writing from skmtc/skmtc is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.

Install it, pinned
mdr add skmtc/skmtc/docs-writing@v0.2.0

Pins v0.2.0 in mdr.lock. Pin the fingerprint instead.

Audit grade
A, 17 of 17 checks passed
Kind
SKILL.md skill
Repository
skmtc/skmtc
Path
deno/docs/skills/docs-writing/SKILL.md
Versions recorded
4
Latest version
v0.2.0, committed Oct 19, 2026
First version recorded
Jul 6, 2026
Size
38,371 bytes
Repository stars
19
License
Apache-2.0

Write, restructure, or review documentation — tutorials, how-to guides, reference pages, concept/explanation docs, API references, READMEs, changelogs, release notes, and troubleshooting guides. Distills documentation craft from Mintlify's guides (compiled from technical writers at Stripe, GitHub, Amplitude, and Anaconda), the Diátaxis framework (including the compass and per-type voice), the Google and Microsoft style guides, Every Page Is Page One, Write the Docs, and Docs for Developers…

Collected from public GitHub. Every version is saved exactly as it was and never changes. Install it at an exact version with the mdr tool, and every file is checked before it reaches your agent. The main file is checked against the SHA-256 fingerprint recorded here, and the others against the fingerprints GitHub keeps for its source commit. The automatic checks below grade the latest version, and the same checks always give the same file the same grade.

What the file says

# Writing documentation

Documentation craft distilled for the moment of writing. The core stance:
**people don't read docs for fun; they arrive with a goal — and they read at
most ~20–28% of the words on a page** (NN/g). Every rule below serves getting
the reader from arrival to accomplished goal with minimum friction — and the
same properties that serve a skimming human serve an AI agent reading the page.

Companion files, read on demand:

- `templates.md` — page skeletons + quality bars for how-to, tutorial,
  reference, concept, README, changelog, release notes, and troubleshooting
  pages.
- `mechanics.md` — mechanical enforcement (Vale, markdownlint, link checking,
  testing code examples) and the llms.txt format.

## 1. The seven principles that override default writing intuitions

Writing docs is not writing prose. These override what generic "good writing"
instincts would suggest:

1. **Verify before you document.** Never document behavior you haven't executed,
   observed, or read in the source. LLM-written docs fail here in characteristic
   ways: plausible flags that don't exist, documented _intent_ instead of actual
…

Read the whole file at its exact version.

How to install

The exact contents, by fingerprint
mdr add skmtc/skmtc/docs-writing@sha256:4a9fdce355fe8419

The line at the top of this page pins the label v0.2.0, which is what most people want. This one pins the sha256 fingerprint of the contents instead, so it survives a label being moved. Either way the exact version is written to mdr.lock, and mdr install downloads and checks those contents again, so it installs them exactly or stops with an error.

Badge

mdr badge

[![mdr](https://markdownregistry.com/badge/art_5yzz7nid43rphv56.svg)](https://markdownregistry.com/a/art_5yzz7nid43rphv56)

4 badge image fetches in 30 days. What the badge shows.

Versions

The registry has recorded 4 versions of this file, between Jul 6, 2026 and Oct 19, 2026, about one every 35 days.

versioncommittedcommitsizeaudit
v0.2.0 latest2026-10-19 5b8d1a9 38,371 BA view · diff
v0.2.02026-08-29 8d49f74 38,371 BA view · diff
v0.2.02026-07-07 16c8fb6 38,344 BA view · diff
v0.2.02026-07-06 34a4f19 38,344 BA view

Audit of the latest version

A  17 of 17 checks passed. Fixed automatic checks with no AI involved, so the same checks give the same answer every run.
  • pass: Frontmatter block present
  • pass: Frontmatter declares a name
  • pass: Frontmatter declares a description
  • pass: Size between 200 bytes and 200 KB (38371 bytes)
  • pass: No zero-width or bidi control characters
  • pass: No instruction hidden inside an HTML comment
  • pass: No link to an exfiltration or paste host
  • pass: No credential-shaped string
  • pass: No instruction to send local credentials anywhere
  • pass: No text hidden with inline styles
  • pass: No prompt-injection phrasing
  • pass: No curl or wget piped into a shell
  • pass: No recursive delete of root, home or parent
  • pass: No instruction to read or print local credentials
  • pass: No base64 blob over 200 characters
  • pass: No link to a raw IP address
  • pass: No script tag

Source

GitHub

skmtc/skmtc · 19 stars · license Apache-2.0 · pushed 2026-10-31 · branch main

API

GET https://markdownregistry.com/api/v1/artifacts/art_5yzz7nid43rphv56
GET https://markdownregistry.com/api/v1/resolve?ref=skmtc/skmtc/docs-writing
GET https://markdownregistry.com/api/v1/blob/4a9fdce355fe8419b0638c90084908929678642ccd3089736c5e05392a531693

Your AI assistant does the legwork. You hear about the deals worth your word. Hand yours the standing instructions at modelranch.com and it joins the network that reads files like this one.

Guides: the SKILL.md format and its required fields · what to check before you install a skill · how to pin a skill to an exact version · where to find agent skills · keeping a team on the same skills · which agent file does what.

More from skmtc/skmtc

deno Cursor rule
skmtc/skmtc · deno/.cursor/rules/deno.mdc
git:20250517.d2abf41 · audit A · 19 stars
CLAUDE.md@deno CLAUDE.md file
skmtc/skmtc · deno/CLAUDE.md
git:20261031.49144b3 · audit A · 19 stars
CLAUDE.md@deno/cli CLAUDE.md file
skmtc/skmtc · deno/cli/CLAUDE.md
git:20261031.4bd7081 · audit A · 19 stars
CLAUDE.md@deno/cli/commands CLAUDE.md file
skmtc/skmtc · deno/cli/commands/CLAUDE.md
git:20260512.cf674af · audit A · 19 stars
CLAUDE.md@deno/cli/components CLAUDE.md file
skmtc/skmtc · deno/cli/components/CLAUDE.md
git:20260512.cf674af · audit A · 19 stars
CLAUDE.md@deno/cli/lib CLAUDE.md file
skmtc/skmtc · deno/cli/lib/CLAUDE.md
git:20260512.0b472d9 · audit A · 19 stars
CLAUDE.md@deno/cli/tasks CLAUDE.md file
skmtc/skmtc · deno/cli/tasks/CLAUDE.md
git:20260511.35b7f70 · audit A · 19 stars
CLAUDE.md@deno/convert CLAUDE.md file
skmtc/skmtc · deno/convert/CLAUDE.md
git:20260511.6b256f7 · audit A · 19 stars
CLAUDE.md@deno/core CLAUDE.md file
skmtc/skmtc · deno/core/CLAUDE.md
git:20260706.c4263c5 · audit A · 19 stars
CLAUDE.md@deno/core/bench CLAUDE.md file
skmtc/skmtc · deno/core/bench/CLAUDE.md
git:20260506.4b0cc2d · audit A · 19 stars
CLAUDE.md@deno/core/context CLAUDE.md file
skmtc/skmtc · deno/core/context/CLAUDE.md
git:20260527.c1e80b1 · audit A · 19 stars
CLAUDE.md@deno/core/dsl CLAUDE.md file
skmtc/skmtc · deno/core/dsl/CLAUDE.md
git:20260610.0d544f3 · audit A · 19 stars

Every file in skmtc/skmtc

Other files named docs-writing

docs-writing SKILL.md skill
outlinedriven/outline-driven-development · .devin/skills/docs-writing/SKILL.md · Use when asked to write, restructure, or audit documentation with Diataxis types, or to draft a feature docs page or…
git:20260905.1f63894 · audit A · 55 stars

Browse by kind, by grade A, or by owner.