technical-writing is agent-read markdown (skill) from khaledsaeed18/dotclaude: Write and edit developer documentation, guides, design notes, and engineering blog posts with a working writer's discipline: audience and purpose first, one idea per paragraph, examples before abstractions, precise verbs, consistent terms, and structure the reader can scan. Includes formats for how-to guides, reference pages, explanations, and tutorials, and an editing checklist. Use when writing docs, a design note, a release announcement, or a post, or when a draft is accurate but nobody can f.
Indexed from public GitHub and served as immutable, content-addressed versions. Install it pinned to an exact SHA-256 with the mdr CLI, and every file is verified against the hash recorded here before it reaches your agent. The deterministic audit below grades the latest version, and the same file always earns the same grade.
What the file says
Technical writing succeeds when a specific reader can do a specific thing after reading. Decide who the reader is and what they are trying to do before writing a heading. Every later choice (structure, depth, examples, tone) follows from that.
## Before drafting
- **Reader**: their role, what they already know, what they are trying to do, how much time they have. "A backend developer integrating our API for the first time, in an afternoon" beats "developers".
- **Purpose**: teach a skill (tutorial), get a task done (how-to), look something up (reference), or understand why (explanation). Mixing two in one page produces a page that serves neither. Split.
- **Outcome**: the sentence the reader should be able to say afterwards: "I can rotate an API key without downtime."
## The four document types
**Tutorial** (learning-oriented): a guaranteed-to-work path from nothing to a result. Numbered steps, every command shown, expected output shown, no choices offered, no explanations beyond one line ("this creates the config file"). Test it end to end on a clean machine.
…
Pin to a label to follow the author's releases, or to a sha256 to freeze the exact bytes forever. Either way the resolved hash is written to mdr.lock, and mdr install reproduces it on any machine.
GET https://markdownregistry.com/api/v1/artifacts/art_jxu5mgll3cbpj7at
GET https://markdownregistry.com/api/v1/resolve?ref=khaledsaeed18/dotclaude/technical-writing
GET https://markdownregistry.com/api/v1/blob/3262c0d6e4228acf7f7691258181ecc0593a019c6df5672ad37e6b3e158eb32d
Your agent 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.
khaledsaeed18/dotclaude · .agents/skills/improve/SKILL.md · Survey any codebase as a senior advisor and produce prioritized, self-contained implementation plans for OTHER…
khaledsaeed18/dotclaude · .claude-plugin/plugins/docs/skills/adr-writing/SKILL.md · Write Architecture Decision Records that a future engineer can act on: a numbered, immutable record with the context…
khaledsaeed18/dotclaude · .claude-plugin/plugins/docs/skills/openapi-spec/SKILL.md · Write, generate, or review an OpenAPI 3.1 specification for an HTTP API so that it is accurate to the implementation…
khaledsaeed18/dotclaude · .claude-plugin/plugins/docs/skills/readme-writing/SKILL.md · Write or restructure a README that gets a reader from landing to first success in minutes: a one-line purpose, a…
khaledsaeed18/dotclaude · .claude-plugin/plugins/engineering/skills/adversarial-reviewer/SKILL.md · Review code through three hostile personas - the Saboteur, the New Hire, and the Security Auditor - each required to…
khaledsaeed18/dotclaude · .claude-plugin/plugins/engineering/skills/api-design-review/SKILL.md · Review an API contract (REST or GraphQL) before or while it is implemented, checking resource naming, HTTP semantics…
khaledsaeed18/dotclaude · .claude-plugin/plugins/engineering/skills/code-review-response/SKILL.md · Process code-review feedback with technical rigour. Understand each point, check it against the actual codebase, and…
khaledsaeed18/dotclaude · .claude-plugin/plugins/engineering/skills/db-migration-safety/SKILL.md · Review or write a database schema migration with production safety as the bar, checking locks, table rewrites…
khaledsaeed18/dotclaude · .claude-plugin/plugins/engineering/skills/dependency-upgrade/SKILL.md · Upgrade dependencies without breaking the project: audit what is outdated and why it matters (security, EOL, features)…
khaledsaeed18/dotclaude · .claude-plugin/plugins/engineering/skills/dockerfile-best-practices/SKILL.md · Write or review a Dockerfile and compose setup for a production service: multi-stage builds that ship only the runtime…
khaledsaeed18/dotclaude · .claude-plugin/plugins/engineering/skills/error-handling-patterns/SKILL.md · Design and review error handling in a codebase: which errors are expected results versus bugs, typed error hierarchies…
khaledsaeed18/dotclaude · .claude-plugin/plugins/engineering/skills/executing-plans/SKILL.md · Execute a written implementation plan task by task, reviewing it critically first, following each step exactly, running…
nahid-sparktales/agent-dispatcher · skills/knowledge/technical-writing/SKILL.md · Write or repair documentation that stays true to the system it describes — README, setup guide, how-to, API reference…
toongri/oh-my-toong-playground · skills/technical-writing/SKILL.md · Use when reviewing, improving, or writing technical documentation in Korean. Triggers include "문서 리뷰", "테크니컬 라이팅", "기술…
shiwenbin1617/pstack · skills/technical-writing/SKILL.md · Write or edit technical documents, RFCs, and PR descriptions for a clear audience and purpose.
