tech-doc-writer

tech-doc-writer is a skill for Claude Code from johnqtcg/awesome-skills. It costs 133 tokens per session (7,098 once invoked), scanned A, original, MIT.

A guide for writing, reviewing, and improving technical documents such as API documentation, design documents, runbooks, and incident reports.

In plain words
What is it for?
Use it to draft or revise structured engineering documentation, RFCs, architecture decisions, operating guides, and API docs.
Why use it?
It helps turn technical information into clear documents suited to their audience and purpose.

Skill for Claude Code

Written for Claude Code: allowed-tools in frontmatter.

Good fit Use it to draft or revise structured engineering documentation, RFCs, architecture decisions, operating guides, and API docs.

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

Made for: Claude Code.

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

README.md
[![agentmods](https://agentmods.dev/badge/skills/johnqtcg/awesome-skills/tech-doc-writer/github.svg)](https://agentmods.dev/skills/johnqtcg/awesome-skills/tech-doc-writer)
Your own site
<a href="https://agentmods.dev/skills/johnqtcg/awesome-skills/tech-doc-writer"><img src="https://agentmods.dev/badge/skills/johnqtcg/awesome-skills/tech-doc-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 tech-doc-writer

Your own site · 80×15
<a href="https://agentmods.dev/skills/johnqtcg/awesome-skills/tech-doc-writer"><img src="https://agentmods.dev/badge/skills/johnqtcg/awesome-skills/tech-doc-writer.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 133 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 7,098 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. Third-party audits
  • NVIDIA SkillSpector warn 7 Sept 2026
SkillSpector: 2 findings, up to high

These are SkillSpector’s own severities. On a checked sample its high-severity flags on skills were ~96% false positives — a documented command, a public API, a “never do X” rule — so we show them as a caution to read, not a verdict. Why →

  • high Prompt Injection · line 73
    Hidden instructions were detected in comments or invisible text. These could contain malicious directives. Manual review is recommended.
    Fix: Audit all comments and invisible characters. Remove any instructions that direct the agent to perform unauthorized actions. Use plain, reviewable content.
  • high Prompt Injection · line 207
    Hidden instructions were detected in comments or invisible text. These could contain malicious directives. Manual review is recommended.
    Fix: Audit all comments and invisible characters. Remove any instructions that direct the agent to perform unauthorized actions. Use plain, reviewable content.
How audits are shown
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.00133 $0.07098
Opus 5 $0.00067 $0.03549
Sonnet 5 $0.00027 $0.01420
Haiku 4.5 $0.00013 $0.00710

Measured 8d ago against content hash 193c7a67253d, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-12, from the pricing page.

Security

Grade A, and why

tech-doc-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 8d ago.

The scan reads SKILL.md. This mod also ships 10 executable files (scripts/lint_doc.py, scripts/run_regression.sh, scripts/tests/ab_eval.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.

skills/tech-doc-writer/SKILL.md · 489 lines

How it starts

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

Tech Doc Writer

Quick Reference

If you need to… Go to
Write a new document from scratch §Execution Modes → Write + §Workflow (Phases 0→5)
Review an existing document for quality §Execution Modes → Review + §Quality Scorecard
Improve / refactor an existing document §Execution Modes → Improve (minimal-diff)
Choose the right document type and template §Gate 2: Classify Type and Audience + Load references/templates.md
Write for a mixed audience (execs + engineers) Load references/writing-quality-guide.md §Funnel Structure
Include code examples or CLI commands Load references/writing-quality-guide.md §Code Examples
Find and fix common doc mistakes (12 anti-patterns) Load references/writing-quality-guide.md §Anti-Examples
Set up doc CI / PR templates / auto-generation Load references/docs-as-code.md

Execution Modes

Write (new document from scratch)

  • Full document generated from audience analysis and type classification.
  • Use templates from templates.md as starting points.
  • Requires Phase 0–5 of the workflow.

Review (evaluate existing document)

  • Read the full document first.
  • Classify its type, then run the Quality Scorecard.
  • Report findings grouped by severity (Critical / Major / Minor).
  • Provide concrete before/after fixes, not vague suggestions.

Improve (refactor existing document)

  • Minimal-diff edits — change only what the scorecard flags; do not rewrite sections that already pass.
  • Preserve the author's voice and existing structure where they work.

Mandatory Gates

Gates are serial. Each must pass before the next. If a gate cannot be executed, apply the Degradation Strategy.

Gate 0: Execution Integrity

  • Never fabricate document content that claims to be from the codebase (commands, configs, API parameters) without verifying it actually exists.
  • Never claim you verified a command is runnable unless you actually executed it.
  • Every command in a delivered document carries a verification level (below). Unlabelled commands are treated as V3.

Read the full file on GitHub · 489 lines

Files

What ships with it

32 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. 8d ago First seen · 489 lines · 133 tokens per session scan A 193c7a67253d

Subscribe to this mod's changes

tech-doc-writer is a skill published in the GitHub repository johnqtcg/awesome-skills (30 stars, last pushed yesterday), licensed MIT. It adds 133 tokens to every session and 7,098 once invoked, about $0.0007 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-09-03.

Related

Other skills, from other repositories

summarize

Summarize or extract text/transcripts from URLs, podcasts, and local files (great fallback for “transcribe this YouTube/video”).

sangrokjung/claude-forge · 32 tokens

security-compliance

Guides security professionals in implementing defense-in-depth security architectures, achieving compliance with industry frameworks (SOC2, ISO27001, GDPR, HIPAA), conducting threat modeling and risk assessments, managing security operations and incident response, and embedding security throughout the SDLC.

sangrokjung/claude-forge · 56 tokens

stride-analysis-patterns

Apply STRIDE methodology to systematically identify threats. Use when analyzing system security, conducting threat modeling sessions, or creating security documentation.

sangrokjung/claude-forge · 30 tokens

cache-components

Expert guidance for Next.js Cache Components and Partial Prerendering (PPR). PROACTIVE ACTIVATION: Use this skill automatically when working in Next.js projects that have cacheComponents: true in their next.config.ts/next.config.js. When this config is detected, proactively apply Cache Components patterns and best…

sangrokjung/claude-forge · 183 tokens

manage-skills

A maintenance workflow for checking whether project verification skills still cover the code and rules that changed during a session.

sangrokjung/claude-forge · 54 tokens

blind-spot-pass

Use before starting work in a domain you don't know well, to surface the "unknown unknowns" — the things you don't even know to ask about — and learn just enough to prompt and decide well. Implements the "blind spot pass" pattern from Anthropic's Fable "finding your unknowns" field guide. Triggers when you say "I'm…

sangrokjung/claude-forge · 221 tokens