Borrowing it
Nothing to install: this file belongs to reasvyn/docsgrep. Take a copy, put it at the same path in your own repository, and replace the rules that are about this project with yours.
curl -O https://raw.githubusercontent.com/reasvyn/docsgrep/main/.agents/skills/doc-writing/SKILL.mdgit clone --depth 1 https://github.com/reasvyn/docsgrepWrote 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/reasvyn/docsgrep/doc-writing)<a href="https://agentmods.dev/skills/reasvyn/docsgrep/doc-writing"><img src="https://agentmods.dev/badge/skills/reasvyn/docsgrep/doc-writing/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/reasvyn/docsgrep/doc-writing"><img src="https://agentmods.dev/badge/skills/reasvyn/docsgrep/doc-writing.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.00026 | $0.00689 |
| Opus 5.5 | $0.00010 | $0.00276 |
| Sonnet 5.5 | $0.00005 | $0.00138 |
| Haiku 4.5 | $0.00003 | $0.00069 |
Grade A, and why
doc-writing 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 2mo 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.
How it starts
The opening of the file, as written. The whole thing — 97 lines — stays where its author put it; the contents beside it link to each section on GitHub.
Before writing docs
- Read
AGENTS.mdfor the documentation update checklist. - Read an existing tool doc in
docs/tools/as a template.
Three documentation layers
| Layer | Location | Audience |
|---|---|---|
| Inline code docs | JSDoc/TSDoc in src/**/*.ts |
Developers reading source |
| Tool reference | docs/tools/<tool_name>.md, docs/README.md |
CLI/MCP users |
| Project-level | Root README.md, CONTRIBUTING.md |
Contributors, newcomers |
Files to update when changing a tool
| What changed | Files to update |
|---|---|
| Tool behavior or args | docs/tools/<tool_name>.md + JSDoc on exported function |
| Tool name or description | src/config/tools.json |
| New tool added | docs/tools/<tool_name>.md, docs/README.md, src/tools/help-info.ts |
| New public function/class | JSDoc on that export in source |
| Major architectural change | README.md |
JSDoc/TSDoc conventions
- Every exported function and class gets a JSDoc block.
- Document
@param,@returns, and any side effects (FS writes, network, process spawn). - Use
{@link}to cross-reference related tools or types.
/**
* Scans the target directory for documentation files.
*
* @param args.dirPath - Root directory to scan from.
* @param args.includePath - Optional glob patterns to include.
* @returns List of discovered documentation file paths.
*/
export async function handleFindDocs(args: FindDocsArgs): Promise<McpToolResponse> {
Per-tool doc template
Create docs/tools/<tool_name>.md:
# `<tool_name>`
One-line tagline.
## Description
Detailed description paragraph(s).
## Arguments
| Argument | Type | Required | Description |
|----------|------|----------|-------------|
| `dirPath` | `string` | Yes | Target directory path |
| `includePath` | `string[]` | No | Glob patterns to include |
## Example
```json
{
"name": "<tool_name>",
"arguments": { "dirPath": "." }
}
```
## Response
Description of the response shape. Include example JSON if complex.
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.
- 2mo ago First seen · 97 lines · 26 tokens per session scan A bde4a4ac3dd4
doc-writing is a skill published in the GitHub repository reasvyn/docsgrep (0 stars, last pushed 3mo ago), licensed MIT. It adds 26 tokens to every session and 689 once invoked, about $0.0001 per session on Opus 5.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.
Other skills, from other repositories
local-ai-agents
Build local-first AI agents that run entirely on a developer workstation with Microsoft Foundry Local and Qwen function-calling models. Covers Small Language Models (SLMs), the OpenAI-compatible local endpoint, sandboxed local tools, local RAG with Chroma, local MCP servers, hybrid cloud/local routing, and the…
systematic-debugging
Use when encountering any bug, test failure, or unexpected behavior, before proposing fixes.
next-cache-components-adoption
Turn on Cache Components in a Next.js app and resolve the blocking routes it surfaces. Use when the user wants to enable, adopt, or migrate to Cache Components, flip the cacheComponents flag, work through a flood of blocking-prerender / instant validation errors, run the cache-components-instant-false codemod, or…
chat-pet-sprite-creation
Use when creating or changing VS Code chat pet sprite art, sprite sheets, state animations, eye treatments, Stable/Insiders variants, or pet transitions under src/vs/workbench/contrib/chat/browser/widget/media/chatPet.
cpu-profile-analysis
Analyze V8/Chrome CPU profiles (.cpuprofile) and DevTools trace files (Trace-.json). Use when: profiling performance, investigating slow functions, comparing code paths, finding bottlenecks, analyzing timeToRequest, understanding call trees from sampling profiler data, analyzing layout/paint/rendering, investigating…
insight-error-page
Write or audit an insight-kind error page for the Next.js dev overlay. Use when creating a new errors/ .mdx page, auditing an existing one, or checking that a page matches the framework fix cards. Covers page structure, title alignment, FixCard cards with Copy prompt button, code snippets, terminology verification…