technical-writing

technical-writing is a skill for Claude Code from KhaledSaeed18/dotclaude. It costs 102 tokens per session (994 once invoked), scanned A, original, MIT.

A guide to writing developer documentation, tutorials, how-to guides, design notes, and engineering articles. It focuses on choosing a reader and outcome first, then using clear structure, examples, and precise terms.

In plain words
What is it for?
It helps produce tutorials, task guides, reference pages, explanations, design notes, and other technical documents suited to their audience.
Why use it?
It prevents documentation from mixing purposes or explaining a system without helping a specific reader complete a task or learn a skill.

Skill for Claude Code

Written for Claude Code: argument-hint in frontmatter.

Part of the docs plugin — 4 skills shipped together

Good fit It helps produce tutorials, task guides, reference pages, explanations, design notes, and other technical documents suited to their audience.

Compare 6 skills from other repositories ↓
Install with agentmods
npx agentmods add skills/khaledsaeed18/dotclaude/technical-writing
Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

Any agent
npx skills add KhaledSaeed18/dotclaude --skill technical-writing
Clone the repo
git clone --depth 1 https://github.com/KhaledSaeed18/dotclaude

Made for: Claude Code.

Or install docs, the plugin that ships this one along with the rest of its 4 skills.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for technical-writing

README.md
[![agentmods](https://agentmods.dev/badge/skills/khaledsaeed18/dotclaude/technical-writing/github.svg)](https://agentmods.dev/skills/khaledsaeed18/dotclaude/technical-writing)
Your own site
<a href="https://agentmods.dev/skills/khaledsaeed18/dotclaude/technical-writing"><img src="https://agentmods.dev/badge/skills/khaledsaeed18/dotclaude/technical-writing/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

agentmods 80×15 button for technical-writing

Your own site · 80×15
<a href="https://agentmods.dev/skills/khaledsaeed18/dotclaude/technical-writing"><img src="https://agentmods.dev/badge/skills/khaledsaeed18/dotclaude/technical-writing.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 102 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 994 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5.1 $0.00102 $0.00994
Opus 5.5 $0.00041 $0.00398
Sonnet 5.5 $0.00020 $0.00199
Haiku 4.5 $0.00010 $0.00099

Measured 25d ago against content hash 3262c0d6e422, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

technical-writing scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 25d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

.claude-plugin/plugins/docs/skills/technical-writing/SKILL.md · 64 lines

How it starts

The opening of the file, as written. The whole thing — 64 lines — stays where its author put it; the contents beside it link to each section on GitHub.

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.

How-to guide (task-oriented): assumes competence, solves one problem. Title as the goal ("Rotate an API key"). Prerequisites, steps, verification, what can go wrong. Offer choices only where the reader's situation differs.

Reference (information-oriented): complete, consistent, dry. Same structure for every entry (signature, parameters with types and defaults, return, errors, example). Generated from source where possible; hand-written parts kept close to the code.

Explanation (understanding-oriented): why it is designed this way, the trade-offs, the history. Prose, diagrams, no steps. This is where an ADR's reasoning gets its readable form.

Structure

  • Title says what the reader gets. Sentence case.
  • First paragraph: what this page covers and who it is for. A reader in the wrong place leaves in ten seconds instead of ten minutes.
  • Headings the reader can scan to find their case; each section stands alone (readers arrive by search).
  • Example before abstraction: show the call, then explain the parameters.
  • Put the most common case first and the edge cases after, in their own section.
  • End how-tos with verification ("you should now see ...") and next steps.

Read the full file on GitHub · 64 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 25d ago First seen · 64 lines · 102 tokens per session scan A 3262c0d6e422

Subscribe to this mod's changes

technical-writing is a skill published in the GitHub repository KhaledSaeed18/dotclaude (5 stars, last pushed 2d ago), licensed MIT. It adds 102 tokens to every session and 994 once invoked, about $0.0004 per session on Opus 5.5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-09-22.

Related

Other skills, from other repositories

skill-creation-walkthrough

Step-by-step guide for creating your own Claude Skills, from deciding whether a skill is the right tool to writing the SKILL.md file, structuring reference material, and making it trigger reliably. Use when you want to package a workflow, framework, or repeated task into a reusable Skill, when an existing skill is not…

rampstackco/claude-skills · 135 tokens

interactive-product-tour

Designing in-product tours, tooltips, and contextual help that teach product capabilities without becoming friction. Trigger logic, tour architecture, contextual placement, completion tracking. Honest about tooltip-spam (visual noise that users develop blindness to), one-and-done (help invisible at the moment of…

rampstackco/claude-skills · 138 tokens

team-onboarding-playbook

Design a structured onboarding experience that gets new team members productive in 30, 60, and 90 days. Use when a new hire is joining, when contractors or agency partners need to ramp up, when an existing team is restructuring and members are switching focus, or when current onboarding feels chaotic and slow. Also…

rampstackco/claude-skills · 124 tokens

meta-prompt

Meta-prompting framework for critiquing responses, analyzing solution trajectories, and evaluating AI-generated content quality.

Mindrally/skills · 25 tokens

debate-simulator

Spin up 2-3 expert personas to debate any topic from different angles. Structure: Opening statements, rebuttals, cross-examination, closing arguments.

OneWave-AI/claude-skills · 0 tokens

sports-trivia-builder

Generate sports trivia questions by sport/era/difficulty. Multiple formats with obscure stats, fun facts, pub quiz ready content.

OneWave-AI/claude-skills · 30 tokens