docs SKILL.md skillA

docs from kriscard/skills is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.

Install it, pinned
mdr add kriscard/skills/docs@git:20261014.bd8fc2d

Pins git:20261014.bd8fc2d in mdr.lock. Pin the fingerprint instead.

Audit grade
A, 17 of 17 checks passed
Kind
SKILL.md skill
Repository
kriscard/skills
Path
skills/writing/docs/SKILL.md
Versions recorded
6
Latest version
git:20261014.bd8fc2d, committed Oct 14, 2026
First version recorded
May 27, 2026
Size
3,612 bytes
Repository stars
14
License
MIT

Write or revise technical documentation around one reader job: reference, operation, review, decision, or product alignment. Use for READMEs, API docs, operational how-tos, RFCs, product design docs, architecture proposals, and ADRs.

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

# Technical Documentation Writer

Write for the reader's job: what they came to understand, decide, or do. A technically correct doc
that does not serve that job is still a failed doc.

## Boundaries

- Use `blog` for publishable articles with an argument, story, or public-facing lesson.
- The user-invoked `teach` skill owns persistent learning workspaces and HTML lessons.
- Use this skill for reference docs, team proposals, decision records, READMEs, API docs, and
  how-to docs whose primary purpose is work, review, or operation.

## Workflow

### 1. Name the doc type and reader job

Identify the document type before drafting: README, API docs, how-to, RFC or architecture proposal,
product design doc, or ADR.

Complete when:

- the doc type is named
- the primary audience is named
- the reader job is stated as `Reader needs to <do/decide/understand> so they can <outcome>`
- missing inputs are requested before drafting

### 2. Load the matching reference

Use the routing table below. If a template or type-specific rule applies, load that reference before
writing.

Complete when the matching reference has been loaded, or no reference applies and that is stated.
…

Read the whole file at its exact version.

How to install

The exact contents, by fingerprint
mdr add kriscard/skills/docs@sha256:fe8b32a10ee0bb96

The line at the top of this page pins the label git:20261014.bd8fc2d, 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_vhgxosnk5cqjlgml.svg)](https://markdownregistry.com/a/art_vhgxosnk5cqjlgml)

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

Versions

The registry has recorded 6 versions of this file, between May 27, 2026 and Oct 14, 2026, about one every 28 days.

versioncommittedcommitsizeaudit
git:20261014.bd8fc2d latest2026-10-14 bd8fc2d 3,612 BA view · diff
git:20261008.3a79ad02026-10-08 3a79ad0 3,604 BA view · diff
git:20261007.7f41b572026-10-07 7f41b57 3,602 BA view · diff
git:20260810.4e6ccee2026-08-10 4e6ccee 3,692 BA view · diff
git:20260701.665f2492026-07-01 665f249 3,682 BA view · diff
git:20260527.f2789922026-05-27 f278992 6,465 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 (3612 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

kriscard/skills · 14 stars · license MIT · pushed 2026-10-15 · branch main

API

GET https://markdownregistry.com/api/v1/artifacts/art_vhgxosnk5cqjlgml
GET https://markdownregistry.com/api/v1/resolve?ref=kriscard/skills/docs
GET https://markdownregistry.com/api/v1/blob/fe8b32a10ee0bb96d3b0241a978b17a61d5f9cba00ae156eeae5c8bc545057c3

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 kriscard/skills

CLAUDE.md CLAUDE.md file
kriscard/skills · CLAUDE.md
git:20260929.34c5287 · audit A · 14 stars
analyze-repo SKILL.md skill
kriscard/skills · skills/dev/analyze-repo/SKILL.md · Generate an evidence-backed visual architecture and technical-debt audit for an entire repository.
git:20261006.c9355ee · audit A · 14 stars
architect SKILL.md skill
kriscard/skills · skills/dev/architect/SKILL.md · Guides architecture decisions about service/module boundaries, system trade-offs, ADRs, data flow, rendering strategy…
git:20261006.c9355ee · audit A · 14 stars
codebase-design SKILL.md skill
kriscard/skills · skills/dev/codebase-design/SKILL.md · Design and evaluate module interfaces, depth, seams, adapters, locality, and testability. Use when deciding what a…
git:20261006.c9355ee · audit A · 14 stars
commit SKILL.md skill
kriscard/skills · skills/dev/commit/SKILL.md · Create a conventional commit and optionally push it safely.
git:20261006.e799bc1 · audit A · 14 stars
debug SKILL.md skill
kriscard/skills · skills/dev/debug/SKILL.md · Debug errors, test failures, incorrect output, browser failures, intermittent bugs, and performance regressions through…
git:20261006.60fda2b · audit A · 14 stars
frontend SKILL.md skill
kriscard/skills · skills/dev/frontend/SKILL.md · Frontend engineering for browser-facing applications: TypeScript trust boundaries, semantic accessibility, UI systems…
git:20261007.4c4eb8c · audit A · 14 stars
pr-review SKILL.md skill
kriscard/skills · skills/dev/pr-review/SKILL.md · Bug-first, evidence-only review of a pull request or branch-versus-base diff. Use when the user explicitly asks to…
git:20261007.4d473ae · audit A · 14 stars
react-hook-form-audit SKILL.md skill
kriscard/skills · skills/dev/react-hook-form-audit/SKILL.md · Audit existing React Hook Form code for correctness, accessibility, validation, data ownership, submission…
git:20261007.1f199d1 · audit A · 14 stars
react-hook-form SKILL.md skill
kriscard/skills · skills/dev/react-hook-form/SKILL.md · Build and modify forms that use React Hook Form or whose project conventions require it. Use when implementing…
git:20261007.1f199d1 · audit A · 14 stars
react SKILL.md skill
kriscard/skills · skills/dev/react/SKILL.md · React component architecture and data-flow guidance for composition, state ownership, Effects, Suspense, async UI…
git:20261007.4c4eb8c · audit A · 14 stars
refactor SKILL.md skill
kriscard/skills · skills/dev/refactor/SKILL.md · Behavior-preserving code refactoring. Use when the user asks to simplify complex or duplicated code, improve naming…
git:20261007.131213e · audit A · 14 stars

Every file in kriscard/skills

Other files named docs

docs SKILL.md skill
tanstack/ai · .claude/skills/docs/SKILL.md · Use when writing, editing, or organizing documentation, when planning what docs a feature needs, and whenever planning…
git:20261022.f1b3f65 · audit A · 3,213 stars
docs SKILL.md skill
tanstack/ai · .grok/skills/docs/SKILL.md · Use when writing, editing, or organizing documentation, when planning what docs a feature needs, and whenever planning…
git:20261022.f1b3f65 · audit A · 3,213 stars
docs SKILL.md skill
tanstack/ai · .agents/skills/docs/SKILL.md · Use when writing, editing, or organizing documentation, when planning what docs a feature needs, and whenever planning…
git:20261022.f1b3f65 · audit A · 3,213 stars
docs SKILL.md skill
sipyourdrink-ltd/bernstein · templates/skills/docs/SKILL.md · Documentation - README, API docs, ADRs, tutorials.
git:20260521.b455a7c · audit A · 1,310 stars
docs SKILL.md skill
aiskillstore/marketplace · skills/0xsero/docs/SKILL.md · Research documentation, find examples, explain APIs and libraries - Use when you need to look up official…
git:20260113.222b7de · audit A · 439 stars
docs SKILL.md skill
costiash/claude-code-docs · plugin/skills/docs/SKILL.md · Router for the /docs command. Look up Claude documentation, ask plain-English questions, generate interactive courses…
git:20260731.a42106d · audit B · 55 stars
docs SKILL.md skill
genegulanesjr/lapis · docs/SKILL.md
git:20260707.ca47247 · audit C · 55 stars
docs SKILL.md skill
drafthq/draft · skills/docs/SKILL.md · Primary router for authoring and documentation workflows. Analyzes intent and dispatches primarily to documentation…
git:20260609.d617e1b · audit A · 40 stars

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