docs-patterns SKILL.md skillA
docs-patterns from jartan-llc/grimoire is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.
mdr add jartan-llc/grimoire/docs-patterns@git:20261023.fc78225Pins git:20261023.fc78225 in mdr.lock. Pin the fingerprint instead.
- Audit grade
- A, 17 of 17 checks passed
- Kind
- SKILL.md skill
- Repository
- jartan-llc/grimoire
- Path
plugins/praxis/skills/docs-patterns/SKILL.md- Versions recorded
- 5
- Latest version
- git:20261023.fc78225, committed Oct 23, 2026
- First version recorded
- Aug 17, 2026
- Size
- 6,959 bytes
- Repository stars
- 3
- License
- MIT
Documentation conventions -- doc types, structure, register, per-type rules, and quality standards.
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
# Documentation Writing Patterns
Before writing or reviewing, **load `praxis:plain-writing`** (what to keep and cut, plain voice, the final wording pass) and **read 2-3 existing docs in the same category**. Match them in register, terminology, structure and formatting; where they break a rule in this skill, plain-writing or information-placement, follow the rule in what you write instead of copying the fault, and a reviewer raises no finding for that departure.
## Writing Style
Imperative for instructions ("Use X..."), declarative for specifications ("The User model has these fields..."). If a table communicates it better than prose, use a table.
## Doc Types
Pick the type before the shape -- the four Diataxis types each want a different shape. Two questions place any doc: **action** (doing) or **cognition** (understanding)? **Study** (learning) or **work** (the task at hand)?
| Type | Purpose | Shape | Which am I writing? |
|------|---------|-------|---------------------|
| Tutorial | Learning-oriented -- teach a newcomer by doing | Guided, sequential lesson whose steps are guaranteed to work | "Teaching a beginner start-to-finish; if they follow along they succeed." |
…Read the whole file at its exact version.
How to install
mdr add jartan-llc/grimoire/docs-patterns@sha256:97df795eb8f2394fThe line at the top of this page pins the label git:20261023.fc78225, 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.
[](https://markdownregistry.com/a/art_5db6fvjnb7pqzlj6)
1 badge image fetches in 30 days. What the badge shows.
Versions
The registry has recorded 5 versions of this file, between Aug 17, 2026 and Oct 23, 2026, about one every 17 days.
| version | committed | commit | size | audit | |
|---|---|---|---|---|---|
| git:20261023.fc78225 latest | 2026-10-23 | fc78225 | 6,959 B | A | view · diff |
| git:20261016.a713894 | 2026-10-16 | a713894 | 6,969 B | A | view · diff |
| git:20261015.08115b5 | 2026-10-15 | 08115b5 | 6,239 B | A | view · diff |
| git:20261013.bd4591a | 2026-10-13 | bd4591a | 6,111 B | A | view · diff |
| git:20260817.05c470c | 2026-08-17 | 05c470c | 6,202 B | A | view |
Audit of the latest version
- pass: Frontmatter block present
- pass: Frontmatter declares a name
- pass: Frontmatter declares a description
- pass: Size between 200 bytes and 200 KB (6959 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
jartan-llc/grimoire · 3 stars · license MIT · pushed 2026-10-31 · branch main
API
GET https://markdownregistry.com/api/v1/artifacts/art_5db6fvjnb7pqzlj6 GET https://markdownregistry.com/api/v1/resolve?ref=jartan-llc/grimoire/docs-patterns GET https://markdownregistry.com/api/v1/blob/97df795eb8f2394f351a8b9741a7e9829b38f3b8c3c42c1340f89925c83453ee
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.