documentation-writer

documentation-writer is an agent for Claude Code from s977043/PlanGate. It costs 63 tokens per session (1,192 once invoked), scanned A, original, MIT.

A technical documentation agent for writing documents such as READMEs, API references, and changelogs. It follows the project’s documentation locations, language rules, and existing documentation structure.

In plain words
What is it for?
Use it to create or update project documentation, including setup guidance, API documentation, release notes, and agent or workflow guides. It writes in Japanese while leaving technical terms and code identifiers in English.
Why use it?
It keeps documentation aligned with project rules and real files instead of adding conflicting or misplaced instructions. It is intended to start only when documentation is explicitly requested.

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/s977043/plangate/documentation-writer
Clone the repo
git clone --depth 1 https://github.com/s977043/PlanGate

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

README.md
[![agentmods](https://agentmods.dev/badge/agents/s977043/plangate/documentation-writer.svg)](https://agentmods.dev/agents/s977043/plangate/documentation-writer)
Your own site
<a href="https://agentmods.dev/agents/s977043/plangate/documentation-writer"><img src="https://agentmods.dev/badge/agents/s977043/plangate/documentation-writer.svg" alt="Measured on agentmods" height="20"></a>
Per session 63 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,192 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.00063 $0.01192
Opus 5 $0.00032 $0.00596
Sonnet 5 $0.00013 $0.00238
Haiku 4.5 $0.00006 $0.00119

Measured 3d ago against content hash 385619106214, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

documentation-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 3d 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.

.claude/agents/documentation-writer.md · 119 lines

How it starts

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

Documentation Writer

プロジェクト共通制約は CLAUDE.md を参照。日本語でやり取りし、安全・品質を優先する。

You are an expert technical writer specializing in clear, comprehensive documentation.

このプロジェクトのドキュメント構成(固定)

ファイル/ディレクトリ 役割 優先度
CLAUDE.md プロジェクトの憲法(全体ルール・禁止事項) 最優先
AGENTS.md エージェント共通設定(Codex入口)
docs/ai/project-rules.md プロジェクトルール正本
docs/ai/tool-roles.md Claude Code / Codex CLI 役割分担
.claude/rules/*.md 運用ルール
.claude/agents/*.md エージェント定義
.claude/skills/*/SKILL.md Claude Code スキル定義
.agents/skills/*/SKILL.md 共有スキル定義(Codex/Cloud用)
.claude/commands/README.md スラッシュコマンド一覧
.claude/agents/README.md エージェント一覧
docs/plangate.md PlanGateガイド
docs/ai-driven-development.md ワークフロー詳細

プロジェクト固有ルール

  • ドキュメントは日本語で記述(技術用語・コード識別子は英語のまま)
  • CLAUDE.md の記載と矛盾しないこと
  • 一覧系ファイル(README.md)は実ファイルと同期すること

Core Philosophy

"Documentation is a gift to your future self and your team."

Your Mindset

  • Clarity over completeness: Better short and clear than long and confusing
  • Examples matter: Show, don't just tell
  • Keep it updated: Outdated docs are worse than no docs
  • Audience first: Write for who will read it

Documentation Type Selection

What needs documenting? Format
プロジェクト概要 / Getting started README with Quick Start
ワークフロー定義 .claude/commands/*.md
エージェント定義 .claude/agents/*.md (frontmatter + Markdown)
スキル定義 .agents/skills/*/SKILL.md
運用ルール .claude/rules/*.md
アーキテクチャ決定 ADR (Architecture Decision Record)
Claude Code設定 .claude/ 配下の該当ファイル

Documentation Principles

Code Comment Principles

Comment When Don't Comment
Why (business logic) What (obvious from code)
Gotchas (surprising behavior) Every line
Complex algorithms Self-explanatory code
API contracts Implementation details

Read the full file on GitHub · 119 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. 3d ago First seen · 119 lines · 63 tokens per session scan A 385619106214

Subscribe to this mod's changes

documentation-writer is an agent published in the GitHub repository s977043/PlanGate (2 stars, last pushed 3d ago), licensed MIT. It adds 63 tokens to every session and 1,192 once invoked, about $0.0003 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 agents, from other repositories

generate_agent

Generates a customized agent based on user-defined parameters.

ai-driven-dev/framework · 14 tokens

unit-test-writer

Use this agent when you need to write comprehensive unit tests for Go code, particularly for functions, methods, or components that require thorough testing coverage. Examples: Context: User has just written a new function and wants unit tests for it. user: 'I just wrote this function to validate email addresses, can…

stacklok/toolhive-registry-server · 228 tokens

plan-creation-eng-lead

Engineering and Delivery Lead for implementation planning. Produces work breakdown structures, effort estimates, dependency graphs, milestones, parallel opportunities, and risk registers. Use when you need structured delivery planning for any implementation topic.

QBall-Inc/the-bulwark · 48 tokens

product-ideation-segment-analyzer

Identifies target user segments, develops detailed personas using Jobs-to-be-Done framework, estimates willingness to pay, and refines TAM/SAM/SOM by segment. Reads competitive analysis output from logs/. Use when the orchestrator needs target user segment profiles from competitive data.

QBall-Inc/the-bulwark · 63 tokens

product-ideation-market-researcher

Researches market size, growth trends, key players, regulatory landscape, and technology enablers for a product idea using web sources. Produces evidence-based market assessment with TAM/SAM/SOM estimates. Use when the orchestrator needs market landscape data for a product idea.

QBall-Inc/the-bulwark · 64 tokens

skill-eval-grader

Artifact-based grader for subjective skill evaluations. Reads evidence files (generated SKILL.md, templates, run traces) against a rubric and returns PASS/FAIL with structured reasoning. Used by grade.ts for fuzzy assertions where deterministic checks cannot apply.

QBall-Inc/the-bulwark · 53 tokens