documentation-writing SKILL.md skillA

documentation-writing from higoralves/orc is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.

Install it, pinned
mdr add higoralves/orc/documentation-writing@git:20261020.7a1f356

Pins git:20261020.7a1f356 in mdr.lock. Pin the fingerprint instead.

Audit grade
A, 17 of 17 checks passed
Kind
SKILL.md skill
Repository
higoralves/orc
Path
orc/skills/documentation-writing/SKILL.md
Versions recorded
2
Latest version
git:20261020.7a1f356, committed Oct 20, 2026
First version recorded
Aug 5, 2026
Size
2,703 bytes
Repository stars
7
License
MIT

Diátaxis documentation expert.

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

# Diátaxis Documentation Expert

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:** Verify all information, especially code snippets and technical details, is correct and up-to-date.
3. **User-Centricity:** Always prioritize the user's goal. Every document must help a specific user achieve a specific task.
4. **Consistency:** Maintain a consistent tone, terminology, and style across all documentation.

## YOUR TASK: The Four Document Types

You will create documentation across the four Diátaxis quadrants. You must understand the distinct purpose of each:

- **Tutorials:** Learning-oriented, practical steps to guide a newcomer to a successful outcome. A lesson.
- **How-to Guides:** Problem-oriented, steps to solve a specific problem. A recipe.
- **Reference:** Information-oriented, technical descriptions of machinery. A dictionary.
- **Explanation:** Understanding-oriented, clarifying a particular topic. A discussion.
…

Read the whole file at its exact version.

How to install

The exact contents, by fingerprint
mdr add higoralves/orc/documentation-writing@sha256:82ff47ef4852bcb0

The line at the top of this page pins the label git:20261020.7a1f356, 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_xnbhlg2clo6nnt4w.svg)](https://markdownregistry.com/a/art_xnbhlg2clo6nnt4w)

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

Versions

The registry has recorded 2 versions of this file, between Aug 5, 2026 and Oct 20, 2026, about one every 76 days.

versioncommittedcommitsizeaudit
git:20261020.7a1f356 latest2026-10-20 7a1f356 2,703 BA view · diff
git:20260805.600ee502026-08-05 600ee50 2,696 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 (2703 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

higoralves/orc · 7 stars · license MIT · pushed 2026-10-24 · branch main

API

GET https://markdownregistry.com/api/v1/artifacts/art_xnbhlg2clo6nnt4w
GET https://markdownregistry.com/api/v1/resolve?ref=higoralves/orc/documentation-writing
GET https://markdownregistry.com/api/v1/blob/82ff47ef4852bcb047a7b089c023238097b58f1352a08dbbd93dc9a00eae514e

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 higoralves/orc

CLAUDE.md CLAUDE.md file
higoralves/orc · CLAUDE.md
git:20261020.ba1d30b · audit A · 7 stars
adr-writing SKILL.md skill
higoralves/orc · orc/skills/adr-writing/SKILL.md · Author and update Architecture Decision Records (ADRs) — the durable record of a decision and its trade-offs, in…
git:20261020.7a1f356 · audit A · 7 stars
agent-browser SKILL.md skill
higoralves/orc · orc/skills/agent-browser/SKILL.md · Browser automation CLI for AI agents; use for web tasks - navigate, click, fill forms, screenshot, scrape, test…
git:20261020.7a1f356 · audit A · 7 stars
architecture-patterns SKILL.md skill
higoralves/orc · orc/skills/architecture-patterns/SKILL.md · Implement Clean, Hexagonal (Ports & Adapters), and Domain-Driven architecture patterns
git:20261020.7a1f356 · audit A · 7 stars
browser-qa SKILL.md skill
higoralves/orc · orc/skills/browser-qa/SKILL.md · The canonical browser-QA protocol for web changes — target resolution, env attach, the driver gate (Playwright primary…
git:20261020.7a1f356 · audit A · 7 stars
callouts SKILL.md skill
higoralves/orc · orc/skills/callouts/SKILL.md · The orc callout palette — emoji-header blockquotes in conversation, GitHub-flavored [!TYPE] form for GitHub-bound output
git:20261020.7a1f356 · audit A · 7 stars
caveman-pr SKILL.md skill
higoralves/orc · orc/skills/caveman-pr/SKILL.md · Ultra-compressed, signal-only pull request descriptions
git:20261020.7a1f356 · audit A · 7 stars
caveman-review SKILL.md skill
higoralves/orc · orc/skills/caveman-review/SKILL.md · Ultra-compressed code review comments — one line per finding: location, problem, fix
git:20261020.7a1f356 · audit A · 7 stars
ci-routing SKILL.md skill
higoralves/orc · orc/skills/ci-routing/SKILL.md · The canonical route-on-verdict protocol for a red CI diagnosis — fixable/flake/infra/needs-debug handling, the…
git:20261020.7a1f356 · audit A · 7 stars
cleanup SKILL.md skill
higoralves/orc · orc/skills/cleanup/SKILL.md · Clean up after completed or abandoned orc sessions — removes workspace state, registry entry, git worktree, and…
git:20261020.7a1f356 · audit A · 7 stars
code-discovery SKILL.md skill
higoralves/orc · orc/skills/code-discovery/SKILL.md · Use when discovering or navigating a codebase before planning, implementing, debugging, or refactoring — prefer a…
git:20260820.6962ca7 · audit A · 7 stars
code-review SKILL.md skill
higoralves/orc · orc/skills/code-review/SKILL.md · Review someone else's open GitHub PR — posts a real review with line-anchored inline comments; verdict computed…
git:20261020.7a1f356 · audit A · 7 stars

Every file in higoralves/orc

Other files named documentation-writing

documentation-writing SKILL.md skill
rysweet/amplihack-rs · docs/claude/skills/documentation-writing/SKILL.md · Writing clear, discoverable software documentation following the Eight Rules and Diataxis framework. Use when creating…
v1.0.0 · audit A · 11 stars
documentation-writing SKILL.md skill
rysweet/amplihack-rs · amplifier-bundle/skills/documentation-writing/SKILL.md · Writing clear, discoverable software documentation following the Eight Rules and Diataxis framework. Use when creating…
v1.0.0 · audit A · 11 stars

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