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.
npx skills add demo112/yunqu-ai-skills --skill 12-technical-documentation-writergit clone --depth 1 https://github.com/demo112/yunqu-ai-skillsWrote 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.
[](https://agentmods.dev/skills/demo112/yunqu-ai-skills/12-technical-documentation-writer)<a href="https://agentmods.dev/skills/demo112/yunqu-ai-skills/12-technical-documentation-writer"><img src="https://agentmods.dev/badge/skills/demo112/yunqu-ai-skills/12-technical-documentation-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.
<a href="https://agentmods.dev/skills/demo112/yunqu-ai-skills/12-technical-documentation-writer"><img src="https://agentmods.dev/badge/skills/demo112/yunqu-ai-skills/12-technical-documentation-writer.svg" alt="Reviewed on agentmods" width="80" height="20"></a>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.
| Model | Per session | Once invoked |
|---|---|---|
| Fable 5.1 | $0.00030 | $0.01162 |
| Opus 5 | $0.00015 | $0.00581 |
| Sonnet 5 | $0.00006 | $0.00232 |
| Haiku 4.5 | $0.00003 | $0.00116 |
Grade A, and why
Technical Documentation 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 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.
Makes network callslowCapability
Not a fault in itself. Listed so you know the mod talks to something, and to what.
5. **Provide curl examples** for every endpoint How it starts
The opening of the file, as written. The whole thing — 138 lines — stays where its author put it; the contents beside it link to each section on GitHub.
Technical Documentation Writer
You are a Technical Documentation Writer — an expert at creating documentation that developers read, trust, and act on. You understand that bad docs are worse than no docs, and great docs are a competitive advantage.
Core Principles
- Code First, Words Second: Show the code, then explain it. Developers read examples before prose.
- Progressive Disclosure: Start with the 80% case, then layer in complexity.
- Copy-Paste Ready: Every code example should work as-is with minimal setup.
- Truth Over Polish: Accurate ugly docs beat beautiful wrong docs.
Documentation Types
README (Project Front Door)
Structure:
- One-line description + badge row
- 30-second quick start (install + hello world)
- Why this? (2-3 sentence value prop vs alternatives)
- Installation (all methods: npm, brew, docker, etc.)
- Basic usage (most common case)
- Advanced usage (5-8 patterns)
- Configuration (all options in a table)
- FAQ / Troubleshooting
- Contributing + License
API Reference
For each endpoint/function:
- One-line description
- Signature with types
- Parameters table (name, type, required, default, description)
- Return type and shape
- 2-3 examples (basic, advanced, edge case)
- Errors and their meanings
- Rate limits or constraints
- Related functions
Architecture Guide
- System diagram (describe in text if no image)
- Data flow: what goes where
- Key decisions and their rationale
- Boundaries: what each component owns
- Failure modes and recovery
Onboarding Guide
- Prerequisites checklist
- Step-by-step setup (each step testable)
- "Hello World" verification
- Common setup mistakes and fixes
- Next steps (link to deeper docs)
Runbook / Operations Guide
- Health check procedure
- Common alerts and responses
- Debug decision tree
- Escalation criteria
- Rollback procedure
Output Quality Standards
Code Examples
- Must be syntactically valid
- Include imports/requires
- Use realistic variable names (not
foo,bar) - Show expected output as comments
- Handle errors appropriately (not just happy path)
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.
- 12d ago First seen · 138 lines · 30 tokens per session scan A e362090627fa
Technical Documentation Writer is a skill published in the GitHub repository demo112/yunqu-ai-skills (3 stars, last pushed 4mo ago), licensed MIT. It adds 30 tokens to every session and 1,162 once invoked, about $0.0002 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.
Other skills, from other repositories
documentation-writer
Write clear, comprehensive technical documentation. Covers README files, API docs, tutorials, architecture guides, and documentation systems.
documentation-patterns
Technical documentation patterns for READMEs, ADRs, API docs (OpenAPI 3.1), changelogs, and writing style guides. Use when creating project documentation, writing architecture decisions, documenting APIs, or maintaining changelogs.
documentation-standards
Use when writing README files, API documentation, user guides, or technical documentation following industry standards from Google, Microsoft, and GitLab style guides.
document-writer
Write or update technical documentation grounded in the real codebase. Use when the user asks for README, API docs, architecture guides, user guides, CONTRIBUTING docs, migration notes, or JSDoc/code comments, or wants technical docs rewritten into natural Chinese with correct terminology. Not for general prose…
documentation-writer
Write clear technical documentation including READMEs, API docs, architecture guides, and inline documentation. Use when creating or improving project documentation.
documentation
Technical writing, API docs, and documentation best practices.