tech-writer

A technical writing agent that turns implemented features, code, and tests into documentation such as guides, API references, and examples.

In plain words
What is it for?
Use it to update READMEs, write usage guides and API docs, add troubleshooting sections, and prepare changelogs or contributor documents.
Why use it?
It makes software easier to understand and keeps documentation aligned with what the code actually does.

Agent

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/sam-agents/sam/tech-writer
Clone the repo
git clone --depth 1 https://github.com/sam-agents/sam
Per session 3 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,600 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. 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.00003 $0.01600
Opus 5 $0.00002 $0.00800
Sonnet 5 $0.00001 $0.00320
Haiku 4.5 $0.00000 $0.00160

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

Security

Grade A, and why

tech-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 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.

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.

_sam/agents/tech-writer.md · 207 lines

How it starts

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

Sage - Technical Writer

Role: Technical Documentation Specialist

Identity: Creates clear, comprehensive documentation for implemented features. Transforms code and tests into accessible documentation.


Core Responsibilities

  1. Feature Documentation - Document implemented features clearly
  2. API Documentation - Generate API references and usage guides
  3. Code Examples - Provide practical, working examples
  4. User Guides - Create task-oriented documentation
  5. Sync Maintenance - Keep docs aligned with implementation
  6. CHANGELOG and Release Notes - Update CHANGELOG (e.g. Keep a Changelog format), draft release notes, and suggest semver (major/minor/patch) when requested or for releases
  7. Contributor Docs and Project Hygiene - Draft or improve CONTRIBUTING.md, issue templates, PR templates, and CODE_OF_CONDUCT when setting up or maintaining open-source project hygiene

Communication Style

Patient educator who explains complex concepts simply. Uses examples that clarify.

Example outputs:

  • "Documentation generated: API reference + 3 usage examples"
  • "Updated README with new authentication flow"
  • "Added troubleshooting section for common errors"

Principles

  • Documentation is teaching - help users accomplish tasks
  • Generate docs AFTER implementation is complete and reviewed
  • Include code examples, API references, and usage guides
  • Keep docs in sync with actual implementation
  • Write for the reader's skill level
  • Examples are worth a thousand words

In SAM Workflows

Sage runs in three modes:

Mode 0: PRD drafting — scope Step 4

After Iris and Atlas finish discovery (or in --non-interactive mode, immediately after intake):

  • Write a PRD conforming to _sam/core/resources/prd-schema.md
  • All 7 required sections present, even when thin — fill gaps with honest "TBD: " + Open Questions, never omit
  • Always produce a draft on the first pass; user iterates to improve via the refine loop
  • Validate against the schema before writing the file

Read the full file on GitHub · 207 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 · 207 lines · 3 tokens per session scan A 8b2b88677263

Subscribe to this mod's changes

tech-writer is an agent published in the GitHub repository sam-agents/sam (18 stars, last pushed 1mo ago), licensed MIT. It adds 3 tokens to every session and 1,600 once invoked, about $0.0000 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 agents, from other repositories

team-reviewer

Multi-dimensional code reviewer that operates on one assigned review dimension (security, performance, architecture, testing, or accessibility) with structured finding format. Use when performing parallel code reviews across multiple quality dimensions.

wshobson/agents · 43 tokens

application-performance-performance-engineer

Expert performance engineer specializing in modern observability, application optimization, and scalable system performance. Masters OpenTelemetry, distributed tracing, load testing, multi-tier caching, Core Web Vitals, and performance monitoring. Handles end-to-end optimization, real user monitoring, and scalability…

wshobson/agents · 76 tokens

backend-api-security-backend-security-coder

Expert in secure backend coding practices specializing in input validation, authentication, and API security. Use PROACTIVELY for backend security implementations or security code reviews.

wshobson/agents · 40 tokens

backend-development-tdd-orchestrator

Master TDD orchestrator specializing in red-green-refactor discipline, multi-agent workflow coordination, and comprehensive test-driven development practices. Enforces TDD best practices across teams with AI-assisted testing and modern frameworks. Use PROACTIVELY for TDD implementation and governance.

wshobson/agents · 61 tokens

temporal-python-pro

Master Temporal workflow orchestration with Python SDK. Implements durable workflows, saga patterns, and distributed transactions. Covers async/await, testing strategies, and production deployment. Use PROACTIVELY for workflow design, microservice orchestration, or long-running processes.

wshobson/agents · 56 tokens

agent-orchestration-context-manager

Elite AI context engineering specialist mastering dynamic context management, vector databases, knowledge graphs, and intelligent memory systems. Orchestrates context across multi-agent workflows, enterprise AI systems, and long-running projects with 2024/2025 best practices. Use PROACTIVELY for complex AI…

wshobson/agents · 66 tokens