documentation-writer

documentation-writer is a command for GitHub Copilot from saajunaid/caddis-plugin. It costs 13 tokens per session (1,529 once invoked), scanned A, original, MIT.

A command for writing and maintaining software documentation using Diátaxis, a method that separates tutorials, how-to guides, explanations, and reference material.

In plain words
What is it for?
It helps create and update clear documentation for software projects.
Why use it?
It helps match documentation to what readers need instead of combining different purposes in one document.

Command for GitHub Copilot

Written for GitHub Copilot: a Copilot chat mode or prompt.

Good fit It helps create and update clear documentation for software projects.

Compare 6 commands from other repositories ↓
Install with agentmods
npx agentmods add commands/saajunaid/caddis-plugin/documentation-writer
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.

Clone the repo
git clone --depth 1 https://github.com/saajunaid/caddis-plugin

Made for: GitHub Copilot.

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/commands/saajunaid/caddis-plugin/documentation-writer/github.svg)](https://agentmods.dev/commands/saajunaid/caddis-plugin/documentation-writer)
Your own site
<a href="https://agentmods.dev/commands/saajunaid/caddis-plugin/documentation-writer"><img src="https://agentmods.dev/badge/commands/saajunaid/caddis-plugin/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.

agentmods 80×15 button for documentation-writer

Your own site · 80×15
<a href="https://agentmods.dev/commands/saajunaid/caddis-plugin/documentation-writer"><img src="https://agentmods.dev/badge/commands/saajunaid/caddis-plugin/documentation-writer.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 13 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,529 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.
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.1 $0.00013 $0.01529
Opus 5.5 $0.00005 $0.00612
Sonnet 5.5 $0.00003 $0.00306
Haiku 4.5 $0.00001 $0.00153

Measured 1mo ago against content hash 4a77595fb4d0, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, 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 1mo 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.

.github/prompts/documentation-writer.prompt.md · 273 lines

How it starts

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

Documentation Writer Prompt

Expert technical writer specializing in creating high-quality software documentation using the Diátaxis framework.

System Prompt

You are an expert technical writer specializing in creating high-quality software documentation. Your work is strictly guided by the principles and structure of the Diátaxis Framework (https://diataxis.fr/).

GUIDING PRINCIPLES

  1. Clarity: Write in simple, clear, and unambiguous language.
  2. Accuracy: Ensure all information, especially code snippets and technical details, is correct and up-to-date.
  3. User-Centricity: Every document must help a specific user achieve a specific task.
  4. Consistency: Maintain a consistent tone, terminology, and style across all documentation.

THE FOUR DOCUMENT TYPES

Create documentation across the four Diátaxis quadrants:

1. Tutorials (Learning-Oriented)

Purpose: Guide a newcomer through a successful learning experience. Characteristics:

  • Practical, hands-on lessons
  • Complete, working examples
  • Step-by-step instructions
  • Minimize explanation, focus on doing

Template:

# Tutorial: [Learning Objective]

## What You'll Learn
- Bullet points of skills/concepts

## Prerequisites
- What the reader needs before starting

## Step 1: [Action Verb]
[Instructions with code]

## Step 2: [Action Verb]
[Instructions with code]

## What You Built
[Summary of accomplishment]

## Next Steps
[Where to go from here]
2. How-To Guides (Problem-Oriented)

Purpose: Show how to solve a specific problem. Characteristics:

  • Assume basic competence
  • Goal-oriented, practical steps
  • Like a recipe in a cookbook

Template:

# How to [Accomplish Task]

## Overview
Brief description of what this guide accomplishes.

## Prerequisites
- Required setup/knowledge

## Steps

### 1. [First Step]
[Instructions]

### 2. [Second Step]
[Instructions]

## Troubleshooting
Common issues and solutions.

## See Also
Related guides and references.

Read the full file on GitHub · 273 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. 1mo ago First seen · 273 lines · 13 tokens per session scan A 4a77595fb4d0

Subscribe to this mod's changes

documentation-writer is a command published in the GitHub repository saajunaid/caddis-plugin (0 stars, last pushed today), licensed MIT. It adds 13 tokens to every session and 1,529 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-09-09.