doc-writer

doc-writer is a skill for Claude Code from k1lgor/virtual-company. It costs 34 tokens per session (2,968 once invoked), scanned A, original, MIT.

A guide for writing and maintaining technical documentation, including READMEs, API references, comments, architecture diagrams, and explanations.

In plain words
What is it for?
Use it to inspect code, identify missing documentation, write documentation, and verify that code examples and API details match the implementation.
Why use it?
It reduces the risk of documentation describing code that does not actually work or has changed since the documentation was written.

Skill for Claude Code

Written for Claude Code: allowed-tools in frontmatter. Also seen: mentions CLAUDE.md.

Needs its repository: it runs a file that does not travel with it, so clone the repository first. The line is <project_root>/scripts/validate-skill.sh ./skills/01-doc-writer/SKILL.md.

Part of the virtual-company plugin — 27 skills, 1 command, 6 agents, 3 hooks shipped together

Good fit Use it to inspect code, identify missing documentation, write documentation, and verify that code examples and API details match the implementation.

Compare 6 skills from other repositories ↓
Install

Getting it into your agent

It runs from inside its repository, so the clone comes first — what it calls does not travel with the file alone.

Clone the repo
git clone --depth 1 https://github.com/k1lgor/virtual-company
agentmods
npx agentmods add skills/k1lgor/virtual-company/01-doc-writer

Made for: Claude Code.

Or install virtual-company, the plugin that ships this one along with the rest of its 27 skills, 1 command, 6 agents, 3 hooks.

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

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

Your own site · 80×15
<a href="https://agentmods.dev/skills/k1lgor/virtual-company/01-doc-writer"><img src="https://agentmods.dev/badge/skills/k1lgor/virtual-company/01-doc-writer.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 34 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 2,968 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.00034 $0.02968
Opus 5 $0.00017 $0.01484
Sonnet 5 $0.00007 $0.00594
Haiku 4.5 $0.00003 $0.00297

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

Security

Grade A, and why

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 12d 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.

skills/01-doc-writer/SKILL.md · 320 lines

How it starts

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

✍️ Documentation Expert / Doc Writer

You are the Lead Technical Writer. Your goal is to make complex systems understandable and maintainable through high-quality documentation.

🛑 The Iron Law

NO DOCUMENTATION WITHOUT VERIFICATION AGAINST ACTUAL CODE

Every code example in documentation must be tested. Every API reference must match the actual implementation. Stale documentation is worse than no documentation — it actively misleads.

🛠️ Tool Guidance

  • Deep Audit: Use Read to understand logic before documenting.

  • Mapping: Use Glob to identify undocumented modules or missing READMEs.

  • Execution: Use Edit to create README.md or update source comments.

  • Verification: Use Bash to run code examples and verify they work.

  • Doc Quality Check: Use validate-skill.sh to validate SKILL.md documentation completeness:

    <project_root>/scripts/validate-skill.sh ./skills/01-doc-writer/SKILL.md
    

    Expect a score of 9/10 or higher. Common documentation gaps:

    • Missing README → create one using template below
    • Missing API docs → check api-designer output for endpoint definitions
    • Missing code comments → add JSDoc/docstrings to exported functions
    • Low coverage → use Glob to find undocumented modules and address each

📍 When to Apply

  • "Explain how this module works."
  • "Write a README for this repository."
  • "Add JSDoc/Docstrings to these functions."
  • "What is the high-level architecture of this app?"
  • "Document our API for external consumers."

Decision Tree: Documentation Flow

Read the full file on GitHub · 320 lines

Files

What ships with it

1 file 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. 12d ago First seen · 320 lines · 34 tokens per session scan A 0965893699d9

Subscribe to this mod's changes

doc-writer is a skill published in the GitHub repository k1lgor/virtual-company (4 stars, last pushed 2mo ago), licensed MIT. It adds 34 tokens to every session and 2,968 once invoked, about $0.0002 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-31.

Related

Other skills, from other repositories