technical-documentation SKILL.md skillA

This file is byte-identical to the first copy the registry indexed, one of 3 indexed copies. Same content hash, so the same checks give both the same grade.

technical-documentation from wondelai/skills is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.

Install it, pinned
mdr add wondelai/skills/technical-documentation@v1.0.0

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

Audit grade
A, 17 of 17 checks passed
Kind
SKILL.md skill
Repository
wondelai/skills
Path
technical-documentation/SKILL.md
Versions recorded
1
Latest version
v1.0.0, committed Aug 29, 2026
Size
21,757 bytes
Repository stars
2,546
License
MIT

Audit, write, and improve developer documentation using Google''s Developer Documentation Style Guide and Technical Writing courses. Use this skill for any documentation work, even when the user names no style guide: "audit our docs", "review this README", "write a README", "getting started guide", "how-to or tutorial", "API reference", "docstrings", "CLI help text", "changelog or release notes", "migration guide", or "our docs are confusing". Also use it when writing docs from code, rewriting…

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

Audit, write, and improve developer documentation the way Google's technical writers do: start from the reader's task, verify every fact against the code, then apply the style guide in severity order — structure before voice, voice before word choice.

## Core Principle

**Write for the reader's task, not the product's feature list.** Google's guide asks for prose that is conversational but not frivolous, precise, and consistent, because a developer reading docs is trying to get something done, not to admire the product. Two framing rules from the guide shape everything below:

- **Guidelines, not rules.** Depart from the guide when doing so improves the content — established domain terminology wins — but stay consistent within the document.
- **Precedence.** A project's own style guide comes first, then Google's guide, then Merriam-Webster (spelling), the Chicago Manual of Style (general style), and the Microsoft Writing Style Guide (technical style).
…

Read the whole file at its exact version.

How to install

The exact contents, by fingerprint
mdr add wondelai/skills/technical-documentation@sha256:3037479dd6cffaf0

The line at the top of this page pins the label v1.0.0, 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_ekyj5pxxjc2phyy4.svg)](https://markdownregistry.com/a/art_ekyj5pxxjc2phyy4)

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

Versions

The registry has recorded 1 version of this file, committed on Aug 29, 2026.

versioncommittedcommitsizeaudit
v1.0.0 latest2026-08-29 6621b1f 21,757 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 (21757 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

wondelai/skills · 2,546 stars · license MIT · pushed 2026-09-10 · branch main

API

GET https://markdownregistry.com/api/v1/artifacts/art_ekyj5pxxjc2phyy4
GET https://markdownregistry.com/api/v1/resolve?ref=wondelai/skills/technical-documentation
GET https://markdownregistry.com/api/v1/blob/3037479dd6cffaf043f27cd6b6eaec3cb5fb209210241f73757d15790271b1f2

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

.cursorrules Cursor rule
wondelai/skills · .cursorrules
git:20260701.14a4958 · audit A · 2,546 stars
37signals-way SKILL.md skill
wondelai/skills · 37signals-way/SKILL.md · Build lean, opinionated products using the 37signals philosophy from "Getting Real", "Rework", and "Shape Up". Use when…
v1.3.1 · audit A · 2,546 stars
CLAUDE.md CLAUDE.md file
wondelai/skills · CLAUDE.md
git:20260829.6621b1f · audit A · 2,546 stars
architecture-optimization SKILL.md skill
wondelai/skills · architecture-optimization/SKILL.md · Guided journey from a working codebase grown slow and tangled to one measurably fast, cleanly bounded, and readable…
v1.0.0 · audit A · 2,546 stars
blue-ocean-strategy SKILL.md skill
wondelai/skills · blue-ocean-strategy/SKILL.md · Create uncontested market space using value innovation instead of competing head-to-head. Use when the user mentions…
v1.4.1 · audit A · 2,546 stars
clean-architecture SKILL.md skill
wondelai/skills · clean-architecture/SKILL.md · Structure software around the Dependency Rule: source code dependencies point inward from frameworks to use cases to…
v1.4.0 · audit A · 2,546 stars
clean-code SKILL.md skill
wondelai/skills · clean-code/SKILL.md · Write readable, maintainable code through disciplined naming, small functions, and clean error handling. Use when the…
v1.4.0 · audit A · 2,546 stars
cold-start-problem SKILL.md skill
wondelai/skills · cold-start-problem/SKILL.md · Start and scale networked products using Andrew Chen''s "The Cold Start Problem" framework for network effects. Use…
v1.2.0 · audit A · 2,546 stars
contagious SKILL.md skill
wondelai/skills · contagious/SKILL.md · Engineer word-of-mouth and virality using the STEPPS framework (Social Currency, Triggers, Emotion, Public, Practical…
v1.4.0 · audit A · 2,546 stars
continuous-discovery SKILL.md skill
wondelai/skills · continuous-discovery/SKILL.md · Build a weekly cadence of customer touchpoints using Opportunity Solution Trees, assumption mapping, and interview…
v1.4.0 · audit A · 2,546 stars
conversion-optimization SKILL.md skill
wondelai/skills · conversion-optimization/SKILL.md · Guided journey from a leaking conversion flow - landing page, signup, checkout, or in-app onboarding - to a measured…
v1.0.0 · audit A · 2,546 stars
create-app SKILL.md skill
wondelai/skills · create-app/SKILL.md · Guided journey from a raw app idea to a validated, cleanly architected first version that ships on a sustainable…
v1.0.1 · audit A · 2,546 stars

Every file in wondelai/skills

Other files named technical-documentation

technical-documentation SKILL.md skill
openclaw/clawhub · .agents/skills/technical-documentation/SKILL.md · Build and review high-quality technical docs as well as agent instruction files in your repository.
git:20260617.3a46cdd · audit A · 9,544 stars
technical-documentation SKILL.md skill
wondelai/skills · plugins/wondelai-skills/skills/technical-documentation/SKILL.md · Audit, write, and improve developer documentation using Google''s Developer Documentation Style Guide and Technical…
v1.0.0 · audit A · 2,546 stars
technical-documentation SKILL.md skill
wondelai/skills · plugins/code-craftsmanship/skills/technical-documentation/SKILL.md · Audit, write, and improve developer documentation using Google''s Developer Documentation Style Guide and Technical…
v1.0.0 · audit A · 2,546 stars
technical-documentation SKILL.md skill
magnus919/agent-skills · technical-documentation/SKILL.md · Create and review technical documentation, including READMEs, agent-facing instructions, API references, and CLI help…
git:20260804.6f67a34 · audit A · 162 stars
technical-documentation SKILL.md skill
djarvur/go-ultimate · skills/technical-documentation/SKILL.md · Build and review high-quality technical docs as well as agent instruction files in your repository.
git:20261031.888f514 · audit A · 31 stars
technical-documentation SKILL.md skill
jpeetz/agent-skills · skills/documentation-content/technical-documentation/SKILL.md · Use this skill when creating, maintaining, or auditing technical documentation — READMEs, ADRs, API docs, runbooks…
v1.0.0 · audit A · 15 stars

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