Home / khaledsaeed18 / dotclaude · GitHub

technical-writing SKILL.md skillA

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

Install it, pinned

mdr add khaledsaeed18/dotclaude/technical-writing@git:20260921.b628018

Pins git:20260921.b628018 in mdr.lock. Pin the fingerprint instead.

Audit grade: A, 17 of 17 checks passed
Kind: SKILL.md skill
Repository: khaledsaeed18/dotclaude
Path: skills/documentation/technical-writing/SKILL.md
Versions recorded: 1
Latest version: git:20260921.b628018, committed Sep 21, 2026
Size: 4,529 bytes
Repository stars: 5
License: MIT

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…

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 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.
…

Read the whole file at its exact version.

How to install

The exact contents, by fingerprint

mdr add khaledsaeed18/dotclaude/technical-writing@sha256:3262c0d6e4228acf

The line at the top of this page pins the label git:20260921.b628018, 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](https://markdownregistry.com/badge/art_caz3jypwvs36tosc.svg)](https://markdownregistry.com/a/art_caz3jypwvs36tosc)

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

Versions

The registry has recorded 1 version of this file, committed on Sep 21, 2026.

version	committed	commit	size	audit
git:20260921.b628018 latest	2026-09-21	b628018	4,529 B	A	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 (4529 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

khaledsaeed18/dotclaude · 5 stars · license MIT · pushed 2026-11-05 · branch main

API

GET https://markdownregistry.com/api/v1/artifacts/art_caz3jypwvs36tosc
GET https://markdownregistry.com/api/v1/resolve?ref=khaledsaeed18/dotclaude/technical-writing
GET https://markdownregistry.com/api/v1/blob/3262c0d6e4228acf7f7691258181ecc0593a019c6df5672ad37e6b3e158eb32d

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 khaledsaeed18/dotclaude

improve SKILL.md skill

khaledsaeed18/dotclaude · .agents/skills/improve/SKILL.md · Survey any codebase as a senior advisor and produce prioritized, self-contained implementation plans for OTHER…

v1.0.0 · audit B · 5 stars

coolify-image-app SKILL.md skill

khaledsaeed18/dotclaude · .claude-plugin/plugins/deploy/skills/coolify-image-app/SKILL.md · Create and configure a Coolify application that runs a prebuilt image from a registry. Use when adding an app to…