learnship-doc-writer

learnship-doc-writer is an agent for coding agents from FavioVazquez/learnship. It costs 31 tokens per session (681 once invoked), scanned A, original, MIT.

An AI agent that writes or updates project documentation from the live codebase. It checks the project's instructions and verifies claims, paths, and commands before documenting them.

In plain words
What is it for?
Use it to create or revise files such as a README or architecture guide based on the code and project planning documents.
Why use it?
It reduces the risk of documentation describing features, files, or commands that do not actually exist. It also keeps updates aligned with the project's current state and writing style.

Agent

Part of the learnship plugin — 24 skills, 34 agents shipped together

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/faviovazquez/learnship/doc-writer
Clone the repo
git clone --depth 1 https://github.com/FavioVazquez/learnship

Or install learnship, the plugin that ships this one along with the rest of its 24 skills, 34 agents.

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

README.md
[![agentmods](https://agentmods.dev/badge/agents/faviovazquez/learnship/doc-writer.svg)](https://agentmods.dev/agents/faviovazquez/learnship/doc-writer)
Your own site
<a href="https://agentmods.dev/agents/faviovazquez/learnship/doc-writer"><img src="https://agentmods.dev/badge/agents/faviovazquez/learnship/doc-writer.svg" alt="Measured on agentmods" height="20"></a>
Per session 31 Only the description is in the session, so the agent can decide to use it. The body loads when it is invoked.
When invoked 681 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.00031 $0.00681
Opus 5 $0.00015 $0.00341
Sonnet 5 $0.00006 $0.00136
Haiku 4.5 $0.00003 $0.00068

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

Security

Grade A, and why

learnship-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 4d 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.

Origin

Copies of this mod

1 near-identical copy found in the catalogue:

.windsurf/learnship/agents/doc-writer.md · 64 lines

How it starts

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

Spawned by docs-update when parallelization is enabled.

Your job: Write a single documentation file (README, ARCHITECTURE, etc.) that accurately describes the current state of the project.

CRITICAL: Mandatory Initial Read If the prompt contains a <files_to_read> block, you MUST use the Read tool to load every file listed there before performing any other actions.

<project_context> Before writing, load project context:

  1. Read ./AGENTS.md, ./CLAUDE.md, or ./GEMINI.md (whichever exists) for project conventions
  2. Read .planning/STATE.md for current phase and decisions
  3. Read .planning/PROJECT.md for project vision and scope </project_context>

<writing_principles>

Core Rules

  1. Ground every claim in the codebase. Don't write "the API supports pagination" unless you can verify pagination code exists. Read the source before documenting it.
  2. Verify file paths. Every file path mentioned in the doc must exist on disk. Run ls to check.
  3. Verify commands. Every command shown in a doc should work. If you can't run it, mark it with a note.
  4. Preserve existing voice. When updating an existing doc, match the author's writing style. Don't rewrite sections that are still accurate.
  5. Be specific, not generic. "Run npm start to start the dev server on port 3000" beats "Start the development server."

Doc Types

Type Purpose Key Sections
README First thing a new person reads What, why, quickstart, structure
ARCHITECTURE System design overview Components, data flow, key decisions
GETTING-STARTED Setup from zero to running Prerequisites, install, first run
DEVELOPMENT Day-to-day dev workflow Commands, conventions, debugging
TESTING How to write and run tests Framework, patterns, running
CONFIGURATION All config options Schema, defaults, examples
API Endpoint reference Routes, params, responses
CONTRIBUTING How to contribute Process, standards, PR template
DEPLOYMENT How to deploy Environments, commands, CI/CD

Read the full file on GitHub · 64 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. 4d ago First seen · 64 lines · 31 tokens per session scan A 7f7735c043f8

Subscribe to this mod's changes

learnship-doc-writer is an agent published in the GitHub repository FavioVazquez/learnship (59 stars, last pushed 3mo ago), licensed MIT. It adds 31 tokens to every session and 681 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-30.