technical-writing SKILL.md skillA
technical-writing from korallis/agent-stack is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.
mdr add korallis/agent-stack/technical-writing@git:20260930.ce1c74bPins git:20260930.ce1c74b in mdr.lock. Pin the fingerprint instead.
- Audit grade
- A, 17 of 17 checks passed
- Kind
- SKILL.md skill
- Repository
- korallis/agent-stack
- Path
skills/technical-writing/SKILL.md- Versions recorded
- 1
- Latest version
- git:20260930.ce1c74b, committed Sep 30, 2026
- Size
- 3,821 bytes
- Repository stars
- 35
- License
- Apache-2.0
How to write docs, SPECs, READMEs, runbooks, PR descriptions and commit messages that a tired engineer understands on the first read. Pick the document's mode, write to the reader, one idea per sentence, nothing that reads two ways. Use when writing or reviewing any document; pair with unslop.
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
# Technical writing
Three rules come first:
- Cut every word that does no work.
- Use the short, everyday word, and the real name from the code: the actual file, flag, command or symbol.
- When a rule makes a sentence worse, fix the sentence another way or leave it alone. The rules serve the reader.
## Pick the mode first
One document does one job. Decide which:
- **Tutorial** (learning by doing): says what the reader will build, and every step shows a visible result ("you
should see…"). Minimal explanation, with a link for more.
- **How-to** (steps to a goal): solves one task for someone competent. Action only, forks allowed ("If you use Neon,
do x"). Title it with the task: "Add a secret for the browser".
- **Reference** (facts to look up): describes, completely and without opinion: options, limits, errors, defaults.
Mirrors the structure of the thing it describes.
- **Explanation** (why): one topic, with context, trade-offs and history. Opinion belongs here and nowhere else.
Don't mix them. Split the document and link the parts.
## Write to the reader
- "You", present tense. Commands for instructions: "Run `./install.sh --check`."
…Read the whole file at its exact version.
How to install
mdr add korallis/agent-stack/technical-writing@sha256:c4199a8aebf8bbdfThe line at the top of this page pins the label git:20260930.ce1c74b, 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_zflmevzzwn7wvmll)
5 badge image fetches in 30 days. What the badge shows.
Versions
The registry has recorded 1 version of this file, committed on Sep 30, 2026.
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 (3821 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
korallis/agent-stack · 35 stars · license Apache-2.0 · pushed 2026-10-05 · branch main
API
GET https://markdownregistry.com/api/v1/artifacts/art_zflmevzzwn7wvmll GET https://markdownregistry.com/api/v1/resolve?ref=korallis/agent-stack/technical-writing GET https://markdownregistry.com/api/v1/blob/c4199a8aebf8bbdfdb7df82e276d5a14dfb319d1a09f723a76e7ab456ac6ae40
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 korallis/agent-stack
Every file in korallis/agent-stack