doc-writer SKILL.md skillA

doc-writer from wpfleger96/ai-agent-rules is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.

Install it, pinned
mdr add wpfleger96/ai-agent-rules/doc-writer@v1.0.1

Pins v1.0.1 in mdr.lock. Pin the fingerprint instead.

Audit grade
A, 17 of 17 checks passed
Kind
SKILL.md skill
Repository
wpfleger96/ai-agent-rules
Path
src/ai_rules/config/skills/doc-writer/SKILL.md
Versions recorded
5
Latest version
v1.0.1, committed Aug 22, 2026
First version recorded
May 18, 2026
Size
10,173 bytes
Repository stars
10
License
MIT

Write, update, or review documentation (README, ARCHITECTURE.md, API docs, guides). Use after implementing features to document new APIs, CLI commands, or behavior changes.

Collected from public GitHub. Every version is saved exactly as it was and never changes. Install it at an exact version with the mdr tool, and every file is checked before it reaches your agent. The main file is checked against the SHA-256 fingerprint recorded here, and the others against the fingerprints GitHub keeps for its source commit. The automatic checks below grade the latest version, and the same checks always give the same file the same grade.

What the file says

# Documentation Writing Skill

You are an expert technical documentation assistant that helps create high-quality, concise documentation. Your expertise is writing documentation that respects readers' time.

## Core Philosophy

**Compact Over Comprehensive:** Every sentence must earn its place | Remove everything that doesn't help readers succeed | One clear explanation beats three variations

**Readers Scan, Not Read:** Front-load key information | Use headers as signposts | Code examples > lengthy prose

**Documentation Debt is Real:** Outdated docs worse than no docs | Write what you can maintain | Link don't duplicate

## Core Workflow

### For New Documentation

1. **Identify Document Type**
   - Entry point for new users? → README (name, description, install, quick start)
   - System design/architecture? → ARCHITECTURE.md (components, data flow, key decisions with WHY)
   - Function/class reference? → API docs (signature, params, return, example)
   - How to use feature? → Examples/tutorials (minimal working code, expected output)
   - Common problems? → TROUBLESHOOTING.md (Problem → Cause → Solution with commands)
   - Contributors? → CONTRIBUTING.md
…

Read the whole file at its exact version.

How to install

The exact contents, by fingerprint
mdr add wpfleger96/ai-agent-rules/doc-writer@sha256:bc324465c5f2338f

The line at the top of this page pins the label v1.0.1, which is what most people want. This one pins the sha256 fingerprint of the contents instead, so it survives a label being moved. Either way the exact version is written to mdr.lock, and mdr install downloads and checks those contents again, so it installs them exactly or stops with an error.

Badge

mdr badge

[![mdr](https://markdownregistry.com/badge/art_6gzqvodgehkxokit.svg)](https://markdownregistry.com/a/art_6gzqvodgehkxokit)

2 badge image fetches in 30 days. What the badge shows.

Versions

The registry has recorded 5 versions of this file, between May 18, 2026 and Aug 22, 2026, about one every 24 days.

versioncommittedcommitsizeaudit
v1.0.1 latest2026-08-22 fc3c7df 10,173 BA view · diff
v1.0.12026-07-04 cac8f2d 10,158 BA view · diff
v1.0.12026-06-13 149c6f4 10,047 BA view · diff
v1.0.02026-06-05 8f1ebda 9,979 BA view · diff
git:20260518.05a0e862026-05-18 05a0e86 9,964 BA view

Audit of the latest version

A  17 of 17 checks passed. Fixed automatic checks with no AI involved, so the same checks give the same answer every run.
  • pass: Frontmatter block present
  • pass: Frontmatter declares a name
  • pass: Frontmatter declares a description
  • pass: Size between 200 bytes and 200 KB (10173 bytes)
  • pass: No zero-width or bidi control characters
  • pass: No instruction hidden inside an HTML comment
  • pass: No link to an exfiltration or paste host
  • pass: No credential-shaped string
  • pass: No instruction to send local credentials anywhere
  • pass: No text hidden with inline styles
  • pass: No prompt-injection phrasing
  • pass: No curl or wget piped into a shell
  • pass: No recursive delete of root, home or parent
  • pass: No instruction to read or print local credentials
  • pass: No base64 blob over 200 characters
  • pass: No link to a raw IP address
  • pass: No script tag

Source

GitHub

wpfleger96/ai-agent-rules · 10 stars · license MIT · pushed 2026-10-22 · branch main

API

GET https://markdownregistry.com/api/v1/artifacts/art_6gzqvodgehkxokit
GET https://markdownregistry.com/api/v1/resolve?ref=wpfleger96/ai-agent-rules/doc-writer
GET https://markdownregistry.com/api/v1/blob/bc324465c5f2338f2a18b0ce4b7018faddfdbf59b4f6b812dfb73cba5bf49760

Your AI assistant does the legwork. You hear about the deals worth your word. Hand yours the standing instructions at modelranch.com and it joins the network that reads files like this one.

Guides: the SKILL.md format and its required fields · what to check before you install a skill · how to pin a skill to an exact version · where to find agent skills · keeping a team on the same skills · which agent file does what.

More from wpfleger96/ai-agent-rules

AGENTS.md AGENTS.md file
wpfleger96/ai-agent-rules · AGENTS.md
git:20260929.8dc0b41 · audit A · 10 stars
AGENTS.md@src/ai_rules/config AGENTS.md file
wpfleger96/ai-agent-rules · src/ai_rules/config/AGENTS.md
git:20260930.c325fca · audit A · 10 stars
AGENTS.md@src/ai_rules/config/amp AGENTS.md file
wpfleger96/ai-agent-rules · src/ai_rules/config/amp/AGENTS.md
git:20260704.cac8f2d · audit B · 10 stars
CLAUDE.md@src/ai_rules/config/claude CLAUDE.md file
wpfleger96/ai-agent-rules · src/ai_rules/config/claude/CLAUDE.md
git:20260704.cac8f2d · audit B · 10 stars
AGENTS.md@src/ai_rules/config/codex AGENTS.md file
wpfleger96/ai-agent-rules · src/ai_rules/config/codex/AGENTS.md
git:20260704.cac8f2d · audit B · 10 stars
writing-as-will SKILL.md skill
wpfleger96/ai-agent-rules · src/ai_rules/config/profiles/skills/writing-as-will/SKILL.md · Drafts or edits prose written as Will for human readers, in Will's voice. Use when writing Slack or Buzz messages for…
v1.0.0 · audit A · 10 stars
agents-md SKILL.md skill
wpfleger96/ai-agent-rules · src/ai_rules/config/skills/agents-md/SKILL.md · Create or update AGENTS.md with repo-specific patterns, conventions, commands, and gotchas for LLM coding agents. Use…
v1.0.1 · audit A · 10 stars
code-reviewer SKILL.md skill
wpfleger96/ai-agent-rules · src/ai_rules/config/skills/code-reviewer/SKILL.md · Performs thorough code review on local changes or PRs. Use this skill proactively after implementing code changes to…
v1.2.0 · audit A · 10 stars
continue-crash SKILL.md skill
wpfleger96/ai-agent-rules · src/ai_rules/config/skills/continue-crash/SKILL.md · Continues after a session crash while working on a task
v1.0.0 · audit A · 10 stars
crossfire SKILL.md skill
wpfleger96/ai-agent-rules · src/ai_rules/config/skills/crossfire/SKILL.md · Get multi-model perspectives (Codex + Gemini) on any work product. Use at any development stage — planning, design…
v1.0.0 · audit B · 10 stars
dev-docs SKILL.md skill
wpfleger96/ai-agent-rules · src/ai_rules/config/skills/dev-docs/SKILL.md · Creates or updates PLAN.md based on session - auto-detects create vs update mode
v1.0.1 · audit A · 10 stars
handoff SKILL.md skill
wpfleger96/ai-agent-rules · src/ai_rules/config/skills/handoff/SKILL.md · Generate a portable session handoff document (task, decisions, state, next steps) as a single copy-pasteable markdown…
v1.0.0 · audit A · 10 stars

Every file in wpfleger96/ai-agent-rules

Other files named doc-writer

doc-writer SKILL.md skill
aiskillstore/marketplace · skills/0xhiroki/doc-writer/SKILL.md · Create or update numbered task docs using repo context, DOC_TEMPLATE.md, and naming conventions.
git:20260113.222b7de · audit A · 439 stars
doc-writer SKILL.md skill
claude-world/director-mode-lite · skills/doc-writer/SKILL.md · Documentation templates and standards: README structure, API reference format, changelog (Keep a Changelog), and…
git:20260831.099306a · audit A · 80 stars
doc-writer SKILL.md skill
phuhao00/bony-agent · .agent/skills/doc-writer/SKILL.md · Generates Python docstrings and Markdown documentation. Invoke when user asks to document code or explain functionality.
git:20260617.47f66a5 · audit A · 16 stars
doc-writer SKILL.md skill
phuhao00/bony-agent · electron/resources/agent-skills/doc-writer/SKILL.md · Generates Python docstrings and Markdown documentation. Invoke when user asks to document code or explain functionality.
git:20260617.47f66a5 · audit A · 16 stars

Browse by kind, by grade A, or by owner.