cratis-documentation-writing SKILL.md skillA

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

Install it, pinned
mdr add cratis/ai/cratis-documentation-writing@git:20261003.a58d382

Pins git:20261003.a58d382 in mdr.lock. Pin the fingerprint instead.

Audit grade
A, 17 of 17 checks passed
Kind
SKILL.md skill
Repository
cratis/ai
Path
.cratis/ai/skills/cratis-documentation-writing/SKILL.md
Versions recorded
5
Latest version
git:20261003.a58d382, committed Oct 3, 2026
First version recorded
Sep 29, 2026
Size
12,704 bytes
Repository stars
4
License
MIT

Plan, write, and improve user-centered Cratis documentation with a clear reader journey and one primary Diátaxis purpose per page. Use for product docs, tutorials, how-to guides, reference, explanations, and documentation reviews. For executable examples use cratis-technical-examples; for release notes use cratis-release-notes. Do not invent APIs or publish content.

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

A developer arrives with a job to do, not with an interest in our repository
structure. Start from that job: what did they try, what stopped them, and what
would let them know they succeeded? Use [Diátaxis](https://diataxis.fr/)
as a compass for each page's primary purpose, not a purity test. This skill
governs content and reader journeys; the owning repository governs page
placement, navigation, and rendering.

## Classify before writing

Determine which quadrant the page belongs to before drafting:

| Type | Orientation | Analogy | When to use |
| --- | --- | --- | --- |
| **Tutorial** | Learning | A lesson | Guide a newcomer step-by-step to a successful first outcome |
| **How-to guide** | Problem-solving | A recipe | Show an experienced user how to accomplish a specific task |
| **Reference** | Information | A dictionary | Describe the technical machinery — APIs, attributes, configuration |
| **Explanation** | Understanding | A discussion | Clarify *why* something works the way it does, trade-offs, architecture |

Rules per type:

- **Tutorial** — lead a newcomer through one realistic, threaded outcome.
…

Read the whole file at its exact version.

How to install

The exact contents, by fingerprint
mdr add cratis/ai/cratis-documentation-writing@sha256:0d925576bace963c

The line at the top of this page pins the label git:20261003.a58d382, 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_oss7ix2mlwxmwzp5.svg)](https://markdownregistry.com/a/art_oss7ix2mlwxmwzp5)

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

Versions

The registry has recorded 5 versions of this file, between Sep 29, 2026 and Oct 3, 2026, more than one a day.

versioncommittedcommitsizeaudit
git:20261003.a58d382 latest2026-10-03 a58d382 12,704 BA view · diff
git:20260929.01b92cf2026-09-29 01b92cf 12,323 BA view · diff
git:20260929.224c7e82026-09-29 224c7e8 12,315 BA view · diff
git:20260929.d2a00c82026-09-29 d2a00c8 12,277 BA view · diff
git:20260929.c481f652026-09-29 c481f65 12,265 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 (12704 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

cratis/ai · 4 stars · license MIT · pushed 2026-11-04 · branch main

API

GET https://markdownregistry.com/api/v1/artifacts/art_oss7ix2mlwxmwzp5
GET https://markdownregistry.com/api/v1/resolve?ref=cratis/ai/cratis-documentation-writing
GET https://markdownregistry.com/api/v1/blob/0d925576bace963cf1970a2a6a9c9b5203414258cb67d5cda7ed8df48757ae80

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 cratis/ai

CLAUDE.md@.claude CLAUDE.md file
cratis/ai · .claude/CLAUDE.md
git:20260911.75ad9bc · audit B · 4 stars
analyzing-dotnet-performance SKILL.md skill
cratis/ai · .cratis/ai/skills/analyzing-dotnet-performance/SKILL.md · Use when reviewing .NET hot paths or scanning source for allocation-heavy and inefficient patterns. Not for measuring a…
git:20261026.fc845e3 · audit A · 4 stars
binlog-generation SKILL.md skill
cratis/ai · .cratis/ai/skills/binlog-generation/SKILL.md · Use when an MSBuild failure or performance investigation needs a binary log and none exists. Not for analyzing existing…
git:20261026.fc845e3 · audit A · 4 stars
check-bin-obj-clash SKILL.md skill
cratis/ai · .cratis/ai/skills/check-bin-obj-clash/SKILL.md · Use when multi-project or multi-targeted MSBuild builds collide in bin, obj or project.assets.json, overwrite outputs…
git:20261026.fc845e3 · audit A · 4 stars
coverage-analysis SKILL.md skill
cratis/ai · .cratis/ai/skills/coverage-analysis/SKILL.md · Use when interpreting supplied .NET coverage evidence or an explicit coverage-collection request. Not for hypothetical…
git:20261026.fc845e3 · audit A · 4 stars
cratis-application-react-specifications SKILL.md skill
cratis/ai · .cratis/ai/skills/cratis-application-react-specifications/SKILL.md · Write specifications for the React and TypeScript surface of a Cratis application slice — view models, helpers, command…
git:20261012.b518110 · audit A · 4 stars
cratis-application-slice-conformance SKILL.md skill
cratis/ai · .cratis/ai/skills/cratis-application-slice-conformance/SKILL.md · Reconcile a Cratis slice's hand-written or gap-filled code and specifications with its contract (the `.play` slice and…
git:20261013.e57d5c3 · audit A · 4 stars
cratis-application-slice-specifications SKILL.md skill
cratis/ai · .cratis/ai/skills/cratis-application-slice-specifications/SKILL.md · Specify the backend behavior of an event-sourced Cratis application slice — plain-call specs for pure decisions, plus…
git:20261013.ad33eca · audit A · 4 stars
cratis-arc-authentication-authorization-and-identity SKILL.md skill
cratis/ai · .cratis/ai/skills/cratis-arc-authentication-authorization-and-identity/SKILL.md · Wire authentication, authorization and identity in a Cratis Arc application — IProvideIdentityDetails and the…
git:20261012.9e91c1e · audit A · 4 stars
cratis-arc-command-execution SKILL.md skill
cratis/ai · .cratis/ai/skills/cratis-arc-command-execution/SKILL.md · Execute an existing Cratis Arc command from backend code through ICommandPipeline — the scopeless and scoped overloads…
git:20261012.1578108 · audit A · 4 stars
cratis-arc-command-kotlin SKILL.md skill
cratis/ai · .cratis/ai/skills/cratis-arc-command-kotlin/SKILL.md · Define a Cratis Arc command in Kotlin or Java — the @Command class, its handle() method, the optional provide() step…
git:20261012.0af903a · audit A · 4 stars
cratis-arc-command-operation SKILL.md skill
cratis/ai · .cratis/ai/skills/cratis-arc-command-operation/SKILL.md · Declare immediate inline work as a Cratis Arc ICommandOperation returned by a model-bound command, with optional…
git:20261012.1578108 · audit A · 4 stars

Every file in cratis/ai

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