technical-writer SKILL.md skillA
technical-writer from codeaholicguy/ai-devkit is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.
mdr add codeaholicguy/ai-devkit/technical-writer@git:20260509.950097bPins git:20260509.950097b in mdr.lock. Pin the fingerprint instead.
- Audit grade
- A, 17 of 17 checks passed
- Kind
- SKILL.md skill
- Repository
- codeaholicguy/ai-devkit
- Path
skills/technical-writer/SKILL.md- Versions recorded
- 3
- Latest version
- git:20260509.950097b, committed May 9, 2026
- First version recorded
- Feb 19, 2026
- Size
- 1,722 bytes
- Repository stars
- 1,661
- License
- Apache-2.0
AI DevKit · Review and improve documentation for novice users. Use when users ask to review docs, improve documentation, audit README files, evaluate API docs, review guides, or improve technical writing.
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 Writer Review Review documentation as a novice would experience it. Suggest concrete improvements. ## Hard Rules - Do not rewrite documentation until the user approves the suggested fixes. - Suggest concrete fix text, not vague advice. ## Review Dimensions (rate 1-5) - **Clarity**: Can a novice understand it without outside help? - **Completeness**: Are prerequisites, examples, and edge cases covered? - **Actionability**: Can users copy-paste commands and follow along? - **Structure**: Does it flow logically from simple to complex? ## Priority - **High**: Blocks novice users from succeeding. - **Medium**: Causes confusion but workaround exists. - **Low**: Polish and nice-to-have. ## Red Flags and Rationalizations | Rationalization | Why It's Wrong | Do Instead | |---|---|---| | "Developers will figure it out" | Novice users won't | Write for the least experienced reader | | "The code example speaks for itself" | Examples without context confuse | Add what it does and when to use it | | "Too much detail clutters the doc" | Missing detail blocks users | Include prerequisites and edge cases | ## Output Template ``` ## [Document Name] | Aspect | Rating | Notes | …
Read the whole file at its exact version.
How to install
mdr add codeaholicguy/ai-devkit/technical-writer@sha256:d0d9af1a6512c506The line at the top of this page pins the label git:20260509.950097b, 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_32pzvik4bxcvzr3h)
5 badge image fetches in 30 days. What the badge shows.
Versions
The registry has recorded 3 versions of this file, between Feb 19, 2026 and May 9, 2026, about one every 39 days.
| version | committed | commit | size | audit | |
|---|---|---|---|---|---|
| git:20260509.950097b latest | 2026-05-09 | 950097b | 1,722 B | A | view · diff |
| git:20260403.161e309 | 2026-04-03 | 161e309 | 1,709 B | A | view · diff |
| git:20260219.a11e3d8 | 2026-02-19 | a11e3d8 | 1,289 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 (1722 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
codeaholicguy/ai-devkit · 1,661 stars · license Apache-2.0 · pushed 2026-11-08 · branch main
API
GET https://markdownregistry.com/api/v1/artifacts/art_32pzvik4bxcvzr3h GET https://markdownregistry.com/api/v1/resolve?ref=codeaholicguy/ai-devkit/technical-writer GET https://markdownregistry.com/api/v1/blob/d0d9af1a6512c506e87cc8e7081d5ba2ccf51a2dbf0c6082e7f278bdb8d09f8d
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 codeaholicguy/ai-devkit
Every file in codeaholicguy/ai-devkit