doc-creation SKILL.md skillA

doc-creation from jamestorrevillas/dev-skills is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.

Install it, pinned
mdr add jamestorrevillas/dev-skills/doc-creation@git:20260320.869847a

Pins git:20260320.869847a in mdr.lock. Pin the fingerprint instead.

Audit grade
A, 17 of 17 checks passed
Kind
SKILL.md skill
Repository
jamestorrevillas/dev-skills
Path
.github/skills/doc-creation/SKILL.md
Versions recorded
1
Latest version
git:20260320.869847a, committed Mar 20, 2026
Size
4,236 bytes
Repository stars
3
License
MIT

Use this skill when creating technical documentation, architecture docs, runbooks, READMEs, API references, changelogs, or any structured technical writing. Trigger on keywords: documentation, docs, README, runbook, architecture doc, technical writing, write a guide, document this, API reference, changelog, how-to guide.

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

## Documentation Philosophy

**Write for the reader who is in a hurry and under stress.**

Good documentation answers the question before the reader finishes asking it. Every doc should have a clear audience and a clear job to do.

---

## Documentation Types & When to Use Each

| Type | Purpose | When to Write |
|---|---|---|
| README | Project overview + quickstart | Every project, day 1 |
| Architecture Doc | How the system is designed and why | Before building complex systems |
| Runbook | Step-by-step operational procedures | For anything ops needs to do repeatedly |
| API Reference | Endpoint contracts | When exposing an API to others |
| ADR | Why a significant decision was made | After every major technical decision |
| Changelog | What changed between versions | Every release |
| How-To Guide | Task-oriented instructions | When users need to do a specific thing |

---

## README Template

```markdown
# [Project Name]

One-sentence description of what this does and why it exists.

## Prerequisites
- [Dependency 1] v[X.X]
- [Dependency 2]

## Getting Started
\`\`\`bash
# Clone and install
git clone [repo]
cd [project]
npm install

# Configure
…

Read the whole file at its exact version.

How to install

No tool to install first
claude plugin marketplace add https://markdownregistry.com/mp/a/art_hjgt7cm4fb67akii/a0c645be1918f1b7b13f8a7575d2f78beadb25e17dda57f6013b8ef3584e7fb8.json

Then /plugin install doc-creation@markdownregistry-hjgt7cm4fb67akii in Claude Code. It installs git:20260320.869847a, the one graded A here, pinned to the commit it was graded at, and leaves it there.

The exact contents, by fingerprint
mdr add jamestorrevillas/dev-skills/doc-creation@sha256:a0c645be1918f1b7

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

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

Ask from your agent
claude mcp add --transport http markdownregistry https://markdownregistry.com/mcp/registry

Then ask it: what changed in jamestorrevillas/dev-skills/doc-creation since the version I have? It reads every saved version here, no key and no account. Any agent that speaks MCP can add it.

Got a copy of doc-creation from somewhere else? Ask it: where did my doc-creation come from, and what was changed? It names the public original, the version yours is closest to and every changed line. The text is not kept.

Versions

The registry has recorded 1 version of this file, committed on Mar 20, 2026.

Watch this file (sign in, one email per new version)

versioncommittedcommitsizeaudit
git:20260320.869847a latest2026-03-20 869847a 4,236 BA view
Keep it current by itself, install once

Committed this skill to a repository? Install the markdownregistry skill updates app on it, or on all of them. When the registry saves a newer version, a pull request brings your copy to it within minutes, the newest version first, then what changed and any check it newly trips. A copy you edited is never touched, and nothing is deleted.

Install on GitHub

It asks to read and write contents and pull requests, and to read metadata. No workflow file, no Actions setting, nothing runs on your runners. Uninstall it and everything the registry kept about your repository is deleted.

Keep it current by itself

Committed this skill to a repository? Add one workflow file, and when a newer version is saved, a pull request brings your copy to it, the newest version first, then what changed and any check it newly trips. A copy you edited is never touched, and nothing is deleted.

mkdir -p .github/workflows && curl -fsSL https://markdownregistry.com/ci/skill-updates.yml -o .github/workflows/skill-updates.yml

It runs daily on GitHub Actions, no key and no account. Read the workflow before you add it.

Check a whole project

From the root of your project, one line hashes each installed skill's SKILL.md, your AGENTS.md and your CLAUDE.md, and asks the registry once. Only the fingerprints and paths are sent.

sha256sum .claude/skills/*/SKILL.md AGENTS.md CLAUDE.md | curl -s --data-binary @- https://markdownregistry.com/api/v1/check-copies

In CI, add --fail-with-body: the answer is 409 when any file is behind, so the step fails and still prints which files.

sha256sum .claude/skills/*/SKILL.md AGENTS.md CLAUDE.md | curl -s --fail-with-body --data-binary @- https://markdownregistry.com/api/v1/check-copies

No sha256sum on your machine? shasum -a 256 prints the same lines.

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 (4236 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

jamestorrevillas/dev-skills · 3 stars · license MIT · pushed 2026-03-20 · branch main

API

GET https://markdownregistry.com/api/v1/artifacts/art_hjgt7cm4fb67akii
GET https://markdownregistry.com/api/v1/resolve?ref=jamestorrevillas/dev-skills/doc-creation
GET https://markdownregistry.com/api/v1/blob/a0c645be1918f1b7b13f8a7575d2f78beadb25e17dda57f6013b8ef3584e7fb8

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 jamestorrevillas/dev-skills

copilot-instructions.md
jamestorrevillas/dev-skills · .github/copilot-instructions.md
git:20260320.869847a · audit A · 3 stars
ai-agent-design SKILL.md skill
jamestorrevillas/dev-skills · .github/skills/ai-agent-design/SKILL.md · Use this skill when building AI agents, designing multi-agent systems, integrating LLMs into applications, building RAG…
git:20260320.869847a · audit A · 3 stars
ai-assisted-learning SKILL.md skill
jamestorrevillas/dev-skills · .github/skills/ai-assisted-learning/SKILL.md · Use this skill when using AI to learn new technologies, navigate unfamiliar codebases, do interview prep, identify…
git:20260320.869847a · audit A · 3 stars
ai-prompting-patterns SKILL.md skill
jamestorrevillas/dev-skills · .github/skills/ai-prompting-patterns/SKILL.md · Use this skill when designing how an AI agent should communicate with developers — intent clarification, progress…
git:20260320.869847a · audit A · 3 stars
api-design SKILL.md skill
jamestorrevillas/dev-skills · .github/skills/api-design/SKILL.md · Use this skill when designing or reviewing APIs — REST, GraphQL, tRPC, or gRPC. Trigger on keywords: API design, REST…
git:20260320.869847a · audit A · 3 stars
backend-dev SKILL.md skill
jamestorrevillas/dev-skills · .github/skills/backend-dev/SKILL.md · Use this skill for backend development — server logic, authentication, microservices, serverless functions, middleware…
git:20260320.869847a · audit A · 3 stars
career-growth SKILL.md skill
jamestorrevillas/dev-skills · .github/skills/career-growth/SKILL.md · Use this skill for career planning, goal setting, skill gap analysis, promotion preparation, or thinking through your…
git:20260320.869847a · audit A · 3 stars
client-communication SKILL.md skill
jamestorrevillas/dev-skills · .github/skills/client-communication/SKILL.md · Use this skill when communicating with clients, freelance customers, or external stakeholders — scoping projects…
git:20260320.869847a · audit A · 3 stars
code-explanation SKILL.md skill
jamestorrevillas/dev-skills · .github/skills/code-explanation/SKILL.md · Use this skill when writing code comments, explaining code decisions, documenting the "why" behind implementation…
git:20260320.869847a · audit A · 3 stars
code-reading SKILL.md skill
jamestorrevillas/dev-skills · .github/skills/code-reading/SKILL.md · Use this skill when navigating unfamiliar codebases, understanding legacy code, onboarding to a new project, or…
git:20260320.869847a · audit A · 3 stars
code-review SKILL.md skill
jamestorrevillas/dev-skills · .github/skills/code-review/SKILL.md · Use this skill when performing code reviews, security audits, architecture reviews, vulnerability analysis, or…
git:20260320.869847a · audit A · 3 stars
cross-functional-collab SKILL.md skill
jamestorrevillas/dev-skills · .github/skills/cross-functional-collab/SKILL.md · Use this skill when working with designers, product managers, business stakeholders, or non-technical team members…
git:20260320.869847a · audit A · 3 stars

Every file in jamestorrevillas/dev-skills

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

Kept in .github/skills, the folder GitHub Copilot reads. More agent skills for GitHub Copilot.