What is workflow-write-docs?

A command for creating technical documentation, including a README, API reference, user guides, and setup instructions, with MkDocs Material for a documentation website.

Use it to plan and write documentation for developers, users, operations teams, and project contributors.

It gives documentation work a defined structure, so important information is less likely to be missing or scattered across the project.

How rcdelacruz/claude-code-agents configures Claude Code

Reuse

Borrowing it

Nothing to install: this file belongs to rcdelacruz/claude-code-agents. Take a copy, put it at the same path in your own repository, and replace the rules that are about this project with yours.

Copy the file

curl -O https://raw.githubusercontent.com/rcdelacruz/claude-code-agents/main/.claude/commands/workflow-write-docs.md

Clone the repo

git clone --depth 1 https://github.com/rcdelacruz/claude-code-agents

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.

README.md

[![agentmods](https://agentmods.dev/badge/commands/rcdelacruz/claude-code-agents/workflow-write-docs/github.svg)](https://agentmods.dev/commands/rcdelacruz/claude-code-agents/workflow-write-docs)

Your own site

<a href="https://agentmods.dev/commands/rcdelacruz/claude-code-agents/workflow-write-docs"><img src="https://agentmods.dev/badge/commands/rcdelacruz/claude-code-agents/workflow-write-docs/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.

Your own site · 80×15

<a href="https://agentmods.dev/commands/rcdelacruz/claude-code-agents/workflow-write-docs"><img src="https://agentmods.dev/badge/commands/rcdelacruz/claude-code-agents/workflow-write-docs.svg" alt="Reviewed on agentmods" width="80" height="20"></a>

Per session 8 Only the description is in the session, so the agent can decide to use it. The body loads when it is invoked.

When invoked 4,295 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.

Model	Per session	Once invoked
Fable 5.1	$0.00008	$0.04295
Opus 5.5	$0.00003	$0.01718
Sonnet 5.5	$0.00002	$0.00859
Haiku 4.5	$0.00001	$0.00430

Measured 2mo ago against content hash cf6dc14dbd9b, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

workflow-write-docs 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.

.claude/commands/workflow-write-docs.md · 767 lines

How it starts

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

You are in DOCUMENTATION MODE.

Use tech-writer agent to create professional, comprehensive documentation.

Documentation Workflow

1. Documentation Planning (10 mins)

Identify Documentation Needs

README.md (project overview, quick start)
API Reference (endpoints, schemas, examples)
User Guides (how-to guides, tutorials)
Architecture Documentation (system design, diagrams)
Deployment Documentation (setup, configuration)
Contributing Guidelines
Changelog

Define Target Audience

Developers (API docs, architecture)
End Users (user guides, tutorials)
DevOps (deployment, monitoring)
Contributors (setup, conventions)

Choose Documentation Format

README.md for quick start
MkDocs Material for comprehensive docs site
JSDoc/TSDoc for code documentation
OpenAPI/Swagger for API docs

2. README.md Creation (15 mins)

Essential Sections

# Project Name

Brief, compelling description (1-2 sentences)

## Features
- Feature 1: Description
- Feature 2: Description
- Feature 3: Description

## Quick Start
```bash
# Install
npm install

# Run
npm run dev

Installation

Detailed setup instructions...

Usage

Basic usage examples...

API Reference

Link to full API docs...

Configuration

Environment variables and configuration...

Contributing

How to contribute...

License

MIT License


**README Checklist**
- [ ] Clear project description
- [ ] Quick start (< 5 minutes)
- [ ] Installation instructions
- [ ] Basic usage examples
- [ ] Links to full documentation
- [ ] Badges (build status, coverage, version)
- [ ] Screenshots or demos
- [ ] License information

### 3. MkDocs Material Setup (20 mins)

**Install MkDocs Material**
```bash
pip install mkdocs-material
pip install mkdocs-material[imaging]  # For social cards

Create mkdocs.yml

site_name: Your Project
site_description: Comprehensive documentation
site_author: Your Name
site_url: https://yourusername.github.io/project

repo_name: username/project
repo_url: https://github.com/username/project
edit_uri: edit/main/docs/

theme:
  name: material
  custom_dir: docs/overrides
  language: en
  palette:
    # Light mode
    - scheme: default
      primary: indigo
      accent: blue
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    # Dark mode
    - scheme: slate
      primary: black
      accent: light blue
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  font:
    text: Work Sans
    code: JetBrains Mono
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.sections
    - navigation.expand
    - navigation.indexes
    - navigation.top
    - toc.follow
    - search.suggest
    - search.highlight
    - search.share
    - content.code.copy
    - content.code.annotate

extra_css:
  - stylesheets/extra.css

extra_javascript:
  - https://cdn.jsdelivr.net/npm/mermaid@10/dist/mermaid.min.js
  - javascripts/mermaid-init.js

markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - meta
  - md_in_html
  - toc:
      permalink: true
      toc_depth: 3
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde

nav:
  - Home: index.md
  - Getting Started:
      - Overview: getting-started/overview.md
      - Installation: getting-started/installation.md
      - Quick Start: getting-started/quick-start.md
  - User Guide:
      - Introduction: guide/introduction.md
      - Configuration: guide/configuration.md
      - Usage: guide/usage.md
  - API Reference:
      - Overview: api/overview.md
      - Authentication: api/authentication.md
      - Endpoints: api/endpoints.md
  - Architecture:
      - System Design: architecture/system-design.md
      - Database Schema: architecture/database.md
      - Security: architecture/security.md
  - Deployment:
      - Production: deployment/production.md
      - CI/CD: deployment/cicd.md
  - Contributing:
      - Guidelines: contributing/guidelines.md
      - Development: contributing/development.md

plugins:
  - search

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/username/project

Read the full file on GitHub · 767 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.

2mo ago First seen · 767 lines · 8 tokens per session scan A cf6dc14dbd9b

Subscribe to this mod's changes

workflow-write-docs is a command published in the GitHub repository rcdelacruz/claude-code-agents (2 stars, last pushed 1y ago), licensed MIT. It adds 8 tokens to every session and 4,295 once invoked, about $0.0000 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.

Writing and docs

workflow-write-docs next to 6 commands from other repositories
Mod	Type	Stars	Last push	Licence	Scan	Tokens	Works with
workflow-write-docsrcdelacruz/claude-code-agents	Command	2	1y ago	MIT	A	8	Claude Code
checklistgithub/spec-kit	Command	148k	yesterday	MIT	A	13	Claude Code
clarifygithub/spec-kit	Command	148k	yesterday	MIT	A	27	Claude Code
specifygithub/spec-kit	Command	148k	yesterday	MIT	A	13	Claude Code
analyzegithub/spec-kit	Command	148k	yesterday	MIT	A	26	Claude Code
convergegithub/spec-kit	Command	148k	yesterday	MIT	A	35	Claude Code
implementgithub/spec-kit	Command	148k	yesterday	MIT	A	14	Claude Code

claude-code-agents: Command for Claude Code