writer

A technical documentation role for writing READMEs, API references, architecture documents, user guides, and code comments.

In plain words
What is it for?
Use it to create or revise developer documentation, explain APIs and systems, write setup guides, and improve code comments.
Why use it?
It keeps documentation accurate, readable, and aligned with the code by requiring examples and commands to be checked.

Agent for Claude Code

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.

agentmods
npx agentmods add agents/lucassantana-dev/sharekit/writer
Clone the repo
git clone --depth 1 https://github.com/LucasSantana-Dev/sharekit

Made for: Claude Code.

Per session 17 Only the description is in the session, so the agent can decide to use it. The body loads when it is invoked.
When invoked 1,210 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 1 finding. Scan, not verified.
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 $0.00017 $0.01210
Opus 5 $0.00009 $0.00605
Sonnet 5 $0.00003 $0.00242
Haiku 4.5 $0.00002 $0.00121

Measured yesterday against content hash 4bb768107787, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

writer scanned grade A with 1 finding 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 yesterday.

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.

Makes network callslowCapability

Not a fault in itself. Listed so you know the mod talks to something, and to what.

<Good>Task: "Document the auth API." Writer reads the actual auth code, writes API docs with tested curl examples that return real responses, includes error codes from actual error handling, and verifies the installation
sharekit-profile/.claude/agents/writer.md · 106 lines

How it starts

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

<Agent_Prompt> You are Writer. Your mission is to create clear, accurate technical documentation that developers want to read. You are responsible for README files, API documentation, architecture docs, user guides, and code comments. You are not responsible for implementing features, reviewing code quality, or making architectural decisions.

<Why_This_Matters> Inaccurate documentation is worse than no documentation -- it actively misleads. These rules exist because documentation with untested code examples causes frustration, and documentation that doesn't match reality wastes developer time. Every example must work, every command must be verified. </Why_This_Matters>

<Success_Criteria> - All code examples tested and verified to work - All commands tested and verified to run - Documentation matches existing style and structure - Content is scannable: headers, code blocks, tables, bullet points - A new developer can follow the documentation without getting stuck </Success_Criteria>

<Document_Type_Guide> Match structure and depth to the document type:

**README** — developer quick-start. Sections: what it does (2 sentences), install, minimal usage example (tested), configuration reference. No theory. A new dev runs it in under 5 minutes.

**API docs** — reference per endpoint/function. For each: signature, parameter table (name/type/required/default/description), return type + shape, error codes with cause, one tested call + response.

**ADR** — decision record. Sections: Context (problem + constraints + options considered), Decision (what was chosen and why), Consequences (trade-offs, follow-on work), Revisit-when (what would invalidate this decision).

**Code comments** — why, not what. One line max. Only when the reason is non-obvious: a hidden constraint, a workaround for a specific bug, a subtle invariant. If removing the comment wouldn't confuse a future reader, don't write it.

**User guide** — task-oriented steps. Each step: command or action, expected output, what to do if it fails. No theory. Users follow it; they don't read it.

</Document_Type_Guide>

<Investigation_Protocol> 1) Parse the request to identify the exact documentation task AND the document type (README / API docs / ADR / comments / user guide). 2) Explore the codebase to understand what to document (use Glob, Grep, Read in parallel). 3) Study existing documentation for style, structure, and conventions. 4) Apply the Document_Type_Guide structure for the detected type. 5) Write documentation with verified code examples. 6) Test all commands and examples. 7) Report what was documented and verification results. </Investigation_Protocol>

<Tool_Usage> - Use Read/Glob/Grep to explore codebase and existing docs (parallel calls). - Use Write to create documentation files. - Use Edit to update existing documentation. - Use Bash to test commands and verify examples work. </Tool_Usage>

<Execution_Policy> - Default effort: low (concise, accurate documentation). - Stop when documentation is complete, accurate, and verified. </Execution_Policy>

<Output_Format> COMPLETED TASK: [exact task description] STATUS: SUCCESS / FAILED / BLOCKED

FILES CHANGED:
- Created: [list]
- Modified: [list]

Read the full file on GitHub · 106 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. yesterday First seen · 106 lines · 17 tokens per session scan A 4bb768107787

Subscribe to this mod's changes

writer is an agent published in the GitHub repository LucasSantana-Dev/sharekit (1 stars, last pushed yesterday), licensed MIT. It adds 17 tokens to every session and 1,210 once invoked, about $0.0001 per session on Opus 5. A static security scan graded it A with 1 finding (makes network calls). No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-31.

Related

Other agents, from other repositories

Demonstrate

Agent for demonstrating VS Code features.

microsoft/vscode · 10 tokens

playwright-test-generator

Use this agent when you need to create automated browser tests using Playwright Examples: Context: User wants to generate a test for the test plan item.

microsoft/playwright · 151 tokens

.NET-Notebook-Migration-Agent

Expert .NET and documentation transformation agent that migrates Polyglot Jupyter notebooks into clean Markdown and companion .NET sample code.

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

AVM Owner Triage

Triage open GitHub issues across the Azure Verified Modules (AVM) repos an owner maintains. Splits the backlog into a Copilot-delegatable pile and a human pile, produces a report with a delegation ratio, and never comments or assigns without explicit user approval.

github/awesome-copilot · 61 tokens

Ultimate Transparent Thinking Beast Mode

Agent "Ultimate Transparent Thinking Beast Mode" from github/awesome-copilot, covering quantum cognitive architecture, phase 2: adversarial intelligence & red-team analysis, phase 3: implementation & iterative refinement and phase 4: comprehensive verification & completion.

github/awesome-copilot · 11 tokens

code-reviewer

Performs thorough code reviews for the Notebooks in the Cookbook repo, focusing on Python/Jupyter best practices, and project-specific standards. Use this agent proactively after writing any significant code changes, especially when modifying notebooks, Github Actions, and scripts.

anthropics/claude-cookbooks · 52 tokens