writing-guidelines SKILL.md skillA
writing-guidelines from rohitg00/pro-workflow is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.
mdr add rohitg00/pro-workflow/writing-guidelines@git:20260718.7f7209dPins git:20260718.7f7209d in mdr.lock. Pin the fingerprint instead.
- Audit grade
- A, 17 of 17 checks passed
- Kind
- SKILL.md skill
- Repository
- rohitg00/pro-workflow
- Path
skills/writing-guidelines/SKILL.md- Versions recorded
- 1
- Latest version
- git:20260718.7f7209d, committed Jul 18, 2026
- Size
- 2,371 bytes
- Repository stars
- 2,944
- License
- none declared
Apply clear-writing standards to any prose the agent produces - READMEs, docs, UI copy, error messages, commit and PR text, release notes. Use when writing or editing documentation, interface copy, or any text a human will read. Says "write the README", "improve this copy", "draft the docs", "word this error".
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
# writing-guidelines Write for a reader who is busy and did not see your work. Readability beats cleverness; clarity beats completeness. ## Rules - **Lead with the outcome.** The first sentence answers what happened or what the thing is - the line the reader would ask for if they said "just the TLDR". Supporting detail comes after. - **Cut filler.** Delete "just", "simply", "basically", "in order to", "it is important to note". If a sentence changes nothing when removed, remove it. - **Concrete over abstract.** Name the file, the number, the command. "Faster" is weaker than "cuts the build from 40s to 9s". - **Active voice, one idea per sentence.** Short sentences that each carry one point read faster than long ones that carry three. - **Consistent terms.** Use the project's own vocabulary, the same word for the same thing every time. Tie names to the shared-language `CONTEXT.md` when one exists (see `domain-modeling`). - **Readable, not clipped.** Being short and being clear are different. Achieve short by dropping what the reader does not need, not by compressing prose into fragments, arrow chains (`A -> B -> fails`), or invented abbreviations. …
Read the whole file at its exact version.
How to install
mdr add rohitg00/pro-workflow/writing-guidelines@sha256:5b31009c802a5fe6The line at the top of this page pins the label git:20260718.7f7209d, 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_idjgrkptwjjtwup6)
5 badge image fetches in 30 days. What the badge shows.
Versions
The registry has recorded 1 version of this file, committed on Jul 18, 2026.
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 (2371 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
rohitg00/pro-workflow · 2,944 stars · license none declared · pushed 2026-09-29 · branch main
API
GET https://markdownregistry.com/api/v1/artifacts/art_idjgrkptwjjtwup6 GET https://markdownregistry.com/api/v1/resolve?ref=rohitg00/pro-workflow/writing-guidelines GET https://markdownregistry.com/api/v1/blob/5b31009c802a5fe6ff82a0737909706b59eb27f3e183985100b46e96dbd1a7c4
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 rohitg00/pro-workflow
Every file in rohitg00/pro-workflow