technical-writer

technical-writer is a skill for Claude Code, Codex from librefang/librefang-registry. It costs 21 tokens per session (700 once invoked), scanned A, a copy of technical-writer, MIT.

A guide to writing documentation for developers, including API references, READMEs, architecture decision records, tutorials, and how-to guides. It focuses on matching the document to the reader's goal and defining unfamiliar terms.

In plain words
What is it for?
Use it to create onboarding material, runnable code examples, API documentation, project READMEs, and records of architecture choices.
Why use it?
It helps prevent incomplete examples, inconsistent terminology, and documentation that is difficult to use. It also provides a structure for explaining, teaching, and documenting software decisions.

Skill for Claude CodeCodex

Written for no agent in particular: nothing here depends on one.

Good fit Use it to create onboarding material, runnable code examples, API documentation, project READMEs, and records of architecture choices.

Compare 6 skills from other repositories ↓
Install with agentmods
npx agentmods add skills/librefang/librefang-registry/technical-writer
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 librefang/librefang-registry --skill technical-writer
Clone the repo
git clone --depth 1 https://github.com/librefang/librefang-registry

Made for: Claude Code, Codex.

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-writer

README.md
[![agentmods](https://agentmods.dev/badge/skills/librefang/librefang-registry/technical-writer.svg)](https://agentmods.dev/skills/librefang/librefang-registry/technical-writer)
Your own site
<a href="https://agentmods.dev/skills/librefang/librefang-registry/technical-writer"><img src="https://agentmods.dev/badge/skills/librefang/librefang-registry/technical-writer.svg" alt="Measured on agentmods" height="20"></a>
Per session 21 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 700 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 97% copy Near-identical to another mod 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.00021 $0.00700
Opus 5 $0.00010 $0.00350
Sonnet 5 $0.00004 $0.00140
Haiku 4.5 $0.00002 $0.00070

Measured 4d ago against content hash e96a8c398554, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-07, from the pricing page.

Security

Grade A, and why

technical-writer 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 4d 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.

Origin

This is a copy

97% identical to technical-writer — 3 lines differ, which has more behind it and is treated as the original. This page carries a canonical link to it rather than competing with it.

skills/technical-writer/SKILL.md · 42 lines

How it starts

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

Technical Writing Expertise

You are a senior technical writer specializing in developer documentation, API references, architecture decision records, and onboarding materials. You follow the Diataxis framework to categorize documentation into tutorials, how-to guides, reference material, and explanations. You write with clarity, precision, and empathy for the reader, understanding that documentation is the product's user interface for developers.

Key Principles

  • Write for the reader's context: what do they know, what do they need to accomplish, and what is the fastest path to get them there
  • Separate the four documentation modes: tutorials (learning), how-to guides (problem-solving), reference (information), and explanation (understanding)
  • Every code example must be complete, runnable, and tested; broken examples destroy trust faster than missing documentation
  • Use consistent terminology throughout; define terms on first use and maintain a glossary for domain-specific vocabulary
  • Keep documentation close to the code it describes; colocated docs are updated more frequently than docs in separate repositories

Techniques

  • Structure READMEs with: project name and one-line description, badges (CI, coverage, version), installation instructions, quick-start example, API overview, contributing guide, and license
  • Write API reference entries with: endpoint/function signature, parameter descriptions with types and defaults, return value description, error conditions, and a working example
  • Create Architecture Decision Records (ADRs) with: title, status (proposed/accepted/deprecated), context, decision, and consequences sections
  • Follow changelog conventions (Keep a Changelog format): group entries under Added, Changed, Deprecated, Removed, Fixed, Security headers
  • Use second person ("you") for instructional content and present tense for descriptions; avoid passive voice and jargon without definition
  • Include diagrams (Mermaid, PlantUML) for architecture overviews, sequence flows, and state machines; a diagram is worth a thousand words of prose

Read the full file on GitHub · 42 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. 4d ago First seen · 42 lines · 21 tokens per session scan A e96a8c398554

Subscribe to this mod's changes

technical-writer is a skill published in the GitHub repository librefang/librefang-registry (11 stars, last pushed 14d ago), licensed MIT. It adds 21 tokens to every session and 700 once invoked, about $0.0001 per session on Opus 5. A static security scan graded it A with 0 findings. It is 97% identical to technical-writer, differing in 3 lines, and is treated as a copy.

Related

Other skills, from other repositories

docx

Read, edit, or create Microsoft Word .docx files. Trigger this skill whenever the user mentions a Word document, .docx file, contract, report, brief, memo, or asks to extract text, modify an existing doc, generate one from a brief, or audit tracked changes. Three execution paths: text-and-structure extraction…

opensquilla/opensquilla · 111 tokens

pdf-toolkit

Structured .pdf operations: extract text/tables, merge pages from multiple PDFs, split a PDF by page ranges, fill PDF form fields, and generate fresh PDFs from JSON. Trigger when the user wants programmatic PDF work without natural-language rewriting — examples: pull tables from a report, combine three PDFs, extract…

opensquilla/opensquilla · 127 tokens

xlsx

Read, edit, or create Microsoft Excel .xlsx workbooks. Trigger this skill whenever the user mentions a spreadsheet, .xlsx file, workbook, sheet, formula, pivot table, or asks to extract tabular data, modify a sheet, or build a workbook from rows. Three execution paths: structured inspection, in-place cell edits, and…

opensquilla/opensquilla · 108 tokens

nano-pdf

Edit PDFs with natural-language instructions using the nano-pdf CLI.

opensquilla/opensquilla · 17 tokens

liteparse

Use this skill when the user asks to parse, perform multi-format document conversion or spatially extract text from an unstructured file (PDF, DOCX, PPTX, XLSX, images, etc.) locally without cloud dependencies.

synthetic-sciences/openscience · 49 tokens

meta-pdf-intelligence

Use this meta-skill instead of answering directly when the user needs PDF analysis, pasted PDF excerpt analysis, digesting, comparison, or question answering that benefits from multi-skill orchestration across PDF extraction, summarization, cross-document synthesis, traceable evidence indexing, and memory capture.

opensquilla/opensquilla · 63 tokens