technical-writer

technical-writer is a skill for Claude Code from sjungling/sjungling-claude-plugins. It costs 93 tokens per session (1,853 once invoked), scanned A, original, MIT.

A guide for writing clear technical documentation, including READMEs, tutorials, API references, and release notes.

In plain words
What is it for?
Use it to plan documentation, improve clarity, structure guides, document APIs, and review technical writing.
Why use it?
It helps turn complex technical information into documentation that readers can understand and use.

Skill for Claude Code

Written for Claude Code: shipped in a Claude Code plugin.

Part of the technical-writer plugin — 3 skills, 3 commands, 3 agents shipped together

Good fit Use it to plan documentation, improve clarity, structure guides, document APIs, and review technical writing.

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

Made for: Claude Code.

Or install technical-writer, the plugin that ships this one along with the rest of its 3 skills, 3 commands, 3 agents.

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/sjungling/sjungling-claude-plugins/technical-writer/github.svg)](https://agentmods.dev/skills/sjungling/sjungling-claude-plugins/technical-writer)
Your own site
<a href="https://agentmods.dev/skills/sjungling/sjungling-claude-plugins/technical-writer"><img src="https://agentmods.dev/badge/skills/sjungling/sjungling-claude-plugins/technical-writer/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-writer

Your own site · 80×15
<a href="https://agentmods.dev/skills/sjungling/sjungling-claude-plugins/technical-writer"><img src="https://agentmods.dev/badge/skills/sjungling/sjungling-claude-plugins/technical-writer.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 93 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 1,853 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.00093 $0.01853
Opus 5 $0.00046 $0.00927
Sonnet 5 $0.00019 $0.00371
Haiku 4.5 $0.00009 $0.00185

Measured 10d ago against content hash 7faed0ad5874, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-10, 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 10d ago.

The scan reads SKILL.md. This mod also ships 1 executable file (scripts/validate_markdown.py), listed below but not scanned — reading those needs a real analyzer, not pattern matching.

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.

plugins/technical-writer/skills/technical-writer/SKILL.md · 215 lines

How it starts

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

Technical Documentation Expert

Overview

Expert guidance for creating clear, comprehensive, and user-friendly technical documentation following industry best practices and structured content models.

Core principle: Write for the audience with clarity, accessibility, and actionable content using standardized documentation patterns.

When to Use

Automatically activates when:

  • Working with .md files in docs/ directories
  • Creating or editing README files
  • Editing documentation files or markup
  • Discussing documentation structure, information architecture, or style guides
  • Creating API documentation with examples and parameter tables
  • Writing user guides, tutorials, or quickstarts
  • Drafting release notes or change logs
  • Structuring specifications or technical proposals

Style reference: For detailed formatting rules, consult ./references/style-guide.md.

When NOT to Use

Do not apply this skill for:

  • Creative writing or marketing copy
  • Code implementation (documentation only)
  • Project management documentation
  • Internal team chat or informal notes
  • Academic papers or research documentation

Core Expertise Areas

Content Types

  1. Conceptual -- Explains what something is and why it matters ("About..." articles)
  2. Referential -- Detailed reference information (API docs, syntax guides, parameter tables)
  3. Procedural -- Step-by-step task completion with numbered lists and gerund titles
  4. Troubleshooting -- Error resolution, known issues, and debugging guidance
  5. Quickstart -- Essential setup in 5 minutes / 600 words maximum
  6. Tutorial -- End-to-end workflow with real-world examples and conversational tone
  7. Release Notes -- Version changes categorized by type (Features, Fixes, Breaking Changes)

Documentation Structure

Standard Article Elements:

  • Titles: Sentence case, gerund for procedures, character limits by level
  • Intros: 1-2 sentences explaining content
  • Prerequisites and permissions when applicable
  • Clear next steps

Read the full file on GitHub · 215 lines

Files

What ships with it

2 files beside SKILL.md in the same directory: the scripts, references and assets a skill reads on demand. Not counted in the per-session cost; read them before you install if any of them is executable.

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. 10d ago First seen · 215 lines · 93 tokens per session scan A 7faed0ad5874

Subscribe to this mod's changes

technical-writer is a skill published in the GitHub repository sjungling/sjungling-claude-plugins (13 stars, last pushed 27d ago), licensed MIT. It adds 93 tokens to every session and 1,853 once invoked, about $0.0005 per session on Opus 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-08-30.

Related

Other skills, from other repositories

systematic-debugging

Use when encountering any bug, test failure, or unexpected behavior, before proposing fixes.

obra/superpowers · 21 tokens

local-ai-agents

Build local-first AI agents that run entirely on a developer workstation with Microsoft Foundry Local and Qwen function-calling models. Covers Small Language Models (SLMs), the OpenAI-compatible local endpoint, sandboxed local tools, local RAG with Chroma, local MCP servers, hybrid cloud/local routing, and the…

microsoft/ai-agents-for-beginners · 200 tokens

next-cache-components-adoption

Turn on Cache Components in a Next.js app and resolve the blocking routes it surfaces. Use when the user wants to enable, adopt, or migrate to Cache Components, flip the cacheComponents flag, work through a flood of blocking-prerender / instant validation errors, run the cache-components-instant-false codemod, or…

vercel/next.js · 95 tokens

insight-error-page

Write or audit an insight-kind error page for the Next.js dev overlay. Use when creating a new errors/ .mdx page, auditing an existing one, or checking that a page matches the framework fix cards. Covers page structure, title alignment, FixCard cards with Copy prompt button, code snippets, terminology verification…

vercel/next.js · 83 tokens

next-cache-components-optimizer

Drive a Next.js route to instant navigation by setting up an agentic loop, under Cache Components / PPR, on initial load (hard navigation) and client-side navigation (soft navigation). Encode the goal as a failing @next/playwright instant() e2e and work it to green, one verified route at a time; the shipped test then…

vercel/next.js · 170 tokens

next-partial-prefetching-adoption

Turn on Partial Prefetching in a Next.js app and work through the insights it surfaces. Use when the user wants to enable or adopt Partial Prefetching, flip the partialPrefetching flag, opt routes in with export const prefetch = 'partial', audit Link prefetch={true} behavior, preserve existing prefetched UI with…

vercel/next.js · 103 tokens