author-product-docs SKILL.md skillA
author-product-docs from eugenelim/agent-ready-repo is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.
mdr add eugenelim/agent-ready-repo/author-product-docs@git:20261010.838745dPins git:20261010.838745d in mdr.lock. Pin the fingerprint instead.
- Audit grade
- A, 17 of 17 checks passed
- Kind
- SKILL.md skill
- Repository
- eugenelim/agent-ready-repo
- Path
.agents/skills/author-product-docs/SKILL.md- Versions recorded
- 4
- Latest version
- git:20261010.838745d, committed Oct 10, 2026
- First version recorded
- Jul 28, 2026
- Size
- 19,414 bytes
- Repository stars
- 28
- License
- Apache-2.0
Create, revise, retrofit, audit, or verify user-facing documentation for any software product — a library or SDK, CLI, HTTP or RPC API, framework, web, desktop, or mobile app, service, plugin, or agent-context pack. Covers the whole reader journey: README and landing page, installation, quickstart and tutorials, how-to guides, reference, explanation, troubleshooting, changelog and release notes, migration guides, and contributing guides. Use when asked to write, improve, restructure, audit, or…
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
# Product documentation authoring **The reader's journey decides which page is needed. Diátaxis decides what that page may do. The shipped product decides what it says.** A reader who knows none of the product's internal names must still be able to start a real task from the first screen of any page. This skill is portable. It works in any repository: it discovers the product surface, the existing docs layout, and the audience split from the repository itself, and never assumes a particular directory structure. ## Output rendering <!-- agentbundle:output-rendering:start --> Lead with the useful outcome or next action. Use warm, non-blaming language and everyday words. Define an unfamiliar term in a few plain words before naming it; keep proper names and exact technical terms intact. During tool work, do not narrate routine calls. Send an update only for safety, a blocker, a needed decision, a material scope change, a long wait, or an active host requirement. When requesting input, ask only for what is needed now. Ask dependent questions one at a time; otherwise group related questions. Offer no more than three clear choices when choices help. …
Read the whole file at its exact version.
How to install
mdr add eugenelim/agent-ready-repo/author-product-docs@sha256:93602958da924a46The line at the top of this page pins the label git:20261010.838745d, 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.
[](https://markdownregistry.com/a/art_lghcemyvr3bbteqd)
4 badge image fetches in 30 days. What the badge shows.
Versions
The registry has recorded 4 versions of this file, between Jul 28, 2026 and Oct 10, 2026, about one every 25 days.
| version | committed | commit | size | audit | |
|---|---|---|---|---|---|
| git:20261010.838745d latest | 2026-10-10 | 838745d | 19,414 B | A | view · diff |
| git:20260829.fd59e28 | 2026-08-29 | fd59e28 | 14,149 B | A | view · diff |
| git:20260728.2788a2b | 2026-07-28 | 2788a2b | 11,592 B | A | view · diff |
| git:20260728.ff3f26d | 2026-07-28 | ff3f26d | 7,612 B | A | view |
Audit of the latest version
- pass: Frontmatter block present
- pass: Frontmatter declares a name
- pass: Frontmatter declares a description
- pass: Size between 200 bytes and 200 KB (19414 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
eugenelim/agent-ready-repo · 28 stars · license Apache-2.0 · pushed 2026-11-02 · branch main
API
GET https://markdownregistry.com/api/v1/artifacts/art_lghcemyvr3bbteqd GET https://markdownregistry.com/api/v1/resolve?ref=eugenelim/agent-ready-repo/author-product-docs GET https://markdownregistry.com/api/v1/blob/93602958da924a4601bcbc23a87462ca74ac87051f78c70544ff6d64fc1332db
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 eugenelim/agent-ready-repo
Every file in eugenelim/agent-ready-repo