Technical Writer
finos/morphir
Assists with writing and maintaining Morphir technical documentation.
Write or review a project README.md in plain technical-writer prose — problem it solves and doesn't, honest assessment of tested vs untested, trade-offs, prior art, organization, and usage.
Install Write Readme
$ npx skills add cdiggins/plato --skill write-readme -a claude-codeProject install by default; add -g for ~/.claude/skills/.
$ gh skill install cdiggins/plato write-readme --agent claude-codeProject scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).
$ git clone --depth 1 https://github.com/cdiggins/plato.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.claude/skills/write-readme .claude/skills/write-readme && rm -rf skills-srcUse ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.
Claude Code skills documentation · loads skills from .claude/skills/
Install the "write-readme" agent skill from https://github.com/cdiggins/plato/tree/main/.claude/skills/write-readme into .claude/skills/write-readme/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "write-readme", then confirm the skill loads.Claude Code copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$skill-installer install https://github.com/cdiggins/plato/tree/main/.claude/skills/write-readmeType this inside Codex. $skill-installer <name> installs a curated skill from openai/skills. The installer writes to $CODEX_HOME/skills (default ~/.codex/skills). Restart Codex if the skill does not show up.
$ npx skills add cdiggins/plato --skill write-readme -a codexProject install goes to .agents/skills/; add -g for ~/.codex/skills/.
$ gh skill install cdiggins/plato write-readme --agent codexProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/cdiggins/plato.git skills-src && mkdir -p .agents/skills && cp -r skills-src/.claude/skills/write-readme .agents/skills/write-readme && rm -rf skills-srcUse ~/.agents/skills/ instead of .agents/skills for a personal install.
Codex skills documentation · loads skills from .agents/skills/
Install the "write-readme" agent skill from https://github.com/cdiggins/plato/tree/main/.claude/skills/write-readme into .agents/skills/write-readme/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "write-readme", then confirm the skill loads.Codex copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ npx skills add cdiggins/plato --skill write-readme -a cursorProject install goes to .agents/skills/; add -g for ~/.cursor/skills/.
$ gh skill install cdiggins/plato write-readme --agent cursorProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/cdiggins/plato.git skills-src && mkdir -p .cursor/skills && cp -r skills-src/.claude/skills/write-readme .cursor/skills/write-readme && rm -rf skills-srcUse ~/.cursor/skills/ instead of .cursor/skills for a personal install.
Cursor skills documentation · loads skills from .cursor/skills/, .agents/skills/, .claude/skills/, .codex/skills/
Install the "write-readme" agent skill from https://github.com/cdiggins/plato/tree/main/.claude/skills/write-readme into .cursor/skills/write-readme/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "write-readme", then confirm the skill loads.Cursor copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ gemini skills install https://github.com/cdiggins/plato.git --path .claude/skills/write-readme--scope user (default) or --scope workspace; --path is the subfolder of the repo that holds the skill; --consent skips the security confirmation prompt.
$ npx skills add cdiggins/plato --skill write-readme -a gemini-cliProject install goes to .agents/skills/; add -g for ~/.gemini/skills/.
$ gh skill install cdiggins/plato write-readme --agent gemini-cliProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/cdiggins/plato.git skills-src && mkdir -p .gemini/skills && cp -r skills-src/.claude/skills/write-readme .gemini/skills/write-readme && rm -rf skills-srcUse ~/.gemini/skills/ instead of .gemini/skills for a personal install, then run /skills reload.
Gemini CLI skills documentation · loads skills from .gemini/skills/, .agents/skills/
Install the "write-readme" agent skill from https://github.com/cdiggins/plato/tree/main/.claude/skills/write-readme into .gemini/skills/write-readme/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "write-readme", then confirm the skill loads.Gemini CLI copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ gh skill install cdiggins/plato write-readmeInstalls for Copilot at project scope by default; add --scope user for a personal install. Preview a skill first with gh skill preview. Needs GitHub CLI 2.90.0 or later (public preview).
$ npx skills add cdiggins/plato --skill write-readme -a github-copilotProject install goes to .agents/skills/; add -g for ~/.copilot/skills/.
$ git clone --depth 1 https://github.com/cdiggins/plato.git skills-src && mkdir -p .github/skills && cp -r skills-src/.claude/skills/write-readme .github/skills/write-readme && rm -rf skills-srcUse ~/.copilot/skills/ instead of .github/skills for a personal install. Commit .github/skills so cloud agent and code review can use it.
GitHub Copilot skills documentation · loads skills from .github/skills/, .claude/skills/, .agents/skills/
Install the "write-readme" agent skill from https://github.com/cdiggins/plato/tree/main/.claude/skills/write-readme into .github/skills/write-readme/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "write-readme", then confirm the skill loads.GitHub Copilot copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ npx skills add cdiggins/plato --skill write-readme -a opencodeOpenCode documents no install command of its own. Project install goes to .agents/skills/; add -g for ~/.config/opencode/skills/.
$ gh skill install cdiggins/plato write-readme --agent opencodeProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/cdiggins/plato.git skills-src && mkdir -p .opencode/skills && cp -r skills-src/.claude/skills/write-readme .opencode/skills/write-readme && rm -rf skills-srcUse ~/.config/opencode/skills/ instead of .opencode/skills for a personal install.
OpenCode skills documentation · loads skills from .opencode/skills/, .claude/skills/, .agents/skills/
Install the "write-readme" agent skill from https://github.com/cdiggins/plato/tree/main/.claude/skills/write-readme into .opencode/skills/write-readme/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "write-readme", then confirm the skill loads.OpenCode copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
Facts
- Skill name
write-readme- GitHub stars
- 106
- Token cost
- ~1.6k tokens
- SKILL.md length
- 857 words
- Files
- 1
- Skills in repo
- 5
- Repo updated
- First seen
- Licence
- MIT
At a glance
Write or review a project README.md in plain technical-writer prose — problem it solves and doesn't, honest assessment of tested vs untested, trade-offs, prior art, organization, and usage.
- Works in 11 steps: What it is — one or two sentences a… → What problem it solves — the concrete… → What problem it does NOT solve —… → …
- The user says write a README
- SKILL.md covers Voice and language…, Required content, Additional principles and Procedure
- Instructions only: no scripts, shell commands, URLs or credentials in SKILL.md
What it does
Write Readme is an agent skill from cdiggins/plato. Write or review a project README.md in plain technical-writer prose — problem it solves and doesn't, honest assessment of tested vs untested, trade-offs, prior art, organization, and usage. Use when the user says "write a README", "improve/review the README", "document this project", or a new project/repo lacks a README.
Its SKILL.md is about 1.6k tokens, which your agent loads only when the skill is triggered. It is a single SKILL.md file with no bundled scripts.
It sits in Development, covering Technical documentation, Technical writing and Intellectual property. The repository describes itself as: A simple and efficient cross-platform programming language. The licence is MIT.
When your agent uses it
- The user says write a README
- Improve/review the README
- Document this project
- A new project/repo lacks a README
Example prompts
- “write a README”
- “improve/review the README”
- “document this project”
- “/write-readme”
Workflow steps
11 steps, taken from the first numbered list in SKILL.md.
- What it is — one or two sentences a stranger understands with zero context. Name the
- What problem it solves — the concrete failure or pain that exists without it. A
- What problem it does NOT solve — explicit non-goals and out-of-scope needs. This
- Show the thing early — a small, real example (input and output, a short session, or a
- How to use it — prerequisites stated exactly (language versions, OS, accounts),
- Trade-offs — what was deliberately given up and why (e.g. "no dependencies, so the
- Known and tested vs. untested — separate what is demonstrated (with dates, versions,
- Similar and related prior work — name the closest existing tools, state honestly how
- How the project is organized — a short map of the directories or files that matter
- Who it is for / who it is not for (yet) — the reader should find themselves in one
- License, and where to get help or report problems if applicable.
What it can do on your machine
Read from SKILL.md and the folder at commit f6e02cf. It shows what the files ask for, not the result of running them.
Tool permissions
Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.
From allowed-tools in the SKILL.md frontmatter.
Runs code
No scripts in the folder and no shell commands in SKILL.md.
From the folder's file list and the shell code blocks in SKILL.md.
Network
No URLs in SKILL.md.
From URLs in SKILL.md, links to its own repository left out.
Credentials
Names no API keys, tokens, secrets or passwords.
From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.
Context cost
Write Readme loads about 1.6k tokens when it runs. Until then it costs about 84 tokens; SKILL.md has 857 words of instructions outside code blocks.
Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.
Safety
Auto-check passed
The automated check found no risky patterns in SKILL.md.
Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.
SKILL.md
The full file from cdiggins/plato at commit f6e02cf, republished under its MIT licence (© cdiggins). 857 words, ~1,566 tokens.
Download SKILL.mdSave it as
.claude/skills/write-readme/SKILL.md (or your agent's skills folder).- name
- write-readme
- description
- Write or review a project README.md in plain technical-writer prose — problem it solves and doesn't, honest assessment of tested vs untested, trade-offs, prior art, organization, and usage. Use when the user says "write a README", "improve/review the README", "document this project", or a new project/repo lacks a README.
- argument-hint
- path to project or existing README
<!-- GENERATED by the WorkQuarry installer — do not hand-edit. Edit the source in the workquarry submodule and re-run install.py. -->write-readme — project READMEs in technical-writer prose
Every project and repository gets a README.md written for the user of the project, not its author. The measure of success: a reader of any background can decide whether this project is appropriate for them and, if so, how to use it effectively — without reading the code or asking anyone.
Voice and language (non-negotiable)
- Write as a technical writer, not a marketer and not the proud author.
- Complete sentences. No fragments, no note-style bullets that assume context.
- No jargon. Every unfamiliar term is defined at first use or replaced with a plain phrase ("a YAML header that holds the item's state", not "frontmatter"). Expand every acronym once before using it.
- No marketing language. Ban superlatives ("blazingly fast", "powerful", "simple yet flexible") and unfalsifiable claims. State measurable facts; let the reader judge.
- Active voice, present tense. Say who does what: "the script rebuilds the index", not "the index is rebuilt".
- Consistent terminology: pick one name per interface and never alternate synonyms.
Required content
Cover each of these. Order below is the recommended reading order — motivation before mechanics, honesty before installation.
- What it is — one or two sentences a stranger understands with zero context. Name the audience ("for developers who…").
- What problem it solves — the concrete failure or pain that exists without it. A reader who does not have this problem should realize it here and stop reading, satisfied.
- What problem it does NOT solve — explicit non-goals and out-of-scope needs. This prevents misuse and disappointed adopters, and it is the section most READMEs are missing.
- Show the thing early — a small, real example (input and output, a short session, or a screenshot for visual tools) before any long prose. Readers evaluate artifacts, not descriptions.
- How to use it — prerequisites stated exactly (language versions, OS, accounts), installation commands that have actually been run, and the shortest path to a first success. Include a way to verify the install worked.
- Trade-offs — what was deliberately given up and why (e.g. "no dependencies, so the parser is naive and the schema must stay flat"). Every design buys something by paying something; say both sides.
- Known and tested vs. untested — separate what is demonstrated (with dates, versions, or test evidence) from what is intended, hoped, or unproven. Use absolute dates ("extracted 2026-07-18"), never "currently" or "as of this writing" — those rot silently.
- Similar and related prior work — name the closest existing tools, state honestly how this differs, and keep originality claims narrow. Not inventing the category is normal; pretending to is a credibility hole. Caveat comparisons that may go stale.
- How the project is organized — a short map of the directories or files that matter (a table works well: path, purpose), so a reader can navigate without spelunking.
- Who it is for / who it is not for (yet) — the reader should find themselves in one of these lists.
- License, and where to get help or report problems if applicable.
Show full SKILL.md (358 more words)Show less
Additional principles
- The README is a front door, not a manual. Link to deeper docs rather than inlining design essays, full API references, or change history. Aim for a document readable in five to ten minutes.
- Every claim must be verifiable against the project today. Before finishing: run the install and usage commands (or trace them against the code), check version requirements against the actual source (e.g. syntax features imply a minimum language version), and confirm paths and filenames exist. A README that lies once is distrusted everywhere.
- Write for the skeptical evaluator. The most valuable reader is deciding whether to adopt. Honest weaknesses ("built for a single writer; two branches filing concurrently will collide") build more adoption than hidden ones, because evaluators always find out.
- State maturity plainly. Experimental, personal-use, production, abandoned — say which, and date it. If the project is two days old, say it is two days old.
- Prefer one concrete number to three adjectives. "About 250 lines, no dependencies" beats "lightweight and minimal".
- Anti-patterns to remove on sight: badge walls; feature lists with no problem framing; "simply"/"just" before nontrivial steps; install steps that skip prerequisites; screenshots or examples that no longer match the current behavior; TODO sections; empty boilerplate headings ("Contributing: TBD").
- Maintenance rule: the README changes in the same commit as any behavior it describes. A stale README is worse than a short one.
Procedure
- Read the project first: entry points, real commands, actual dependencies and minimum versions, directory layout, tests. Never write from the author's description alone — the code is the source of truth for every factual claim.
- Ask (or infer from context) anything material you cannot determine: intended audience, maturity, license. Do not invent these.
- Draft in the section order above. Cut any section that would be empty rather than padding it — but treat missing "does not solve", "untested", or "prior art" sections as gaps to research, not sections to skip.
- Verify every command, path, version, and filename against the project.
- Reread once as the target reader: could someone with no context decide, in five minutes, whether and how to use this? Fix whatever blocks that.
© cdiggins, MIT. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file
Files
Just SKILL.md in .claude/skills/write-readme of cdiggins/plato.
Open the folder on GitHubat commit f6e02cf
Compare with similar skills
Write Readme next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.
| Skill | Stars | Used in | Tokens | Auto-check | Licence | Repo updated |
|---|---|---|---|---|---|---|
| Write Readme this skillcdiggins/plato | 106 | — | ~1.6k | Automated safety check: Pass | MIT | |
| Technical Writerfinos/morphir | 213 | — | ~4.4k | Automated safety check: Pass | Apache-2.0 | |
| Diataxis Docs Writercalf-ai/calfkit-sdk | 149 | 1 repos | ~3k | Automated safety check: Pass | Apache-2.0 | |
| Docsbrickbots/PiFinder | 250 | — | ~6.2k | Automated safety check: Pass | GPL-3.0 | |
| Updating Docs For Releasestreamlit/docs | 178 | — | ~4k | Automated safety check: Pass | Apache-2.0 | |
| Doc Writerpretend1111/claude-desktop-app | 496 | 1 repos | ~375 | Automated safety check: Pass | Custom licence |
Similar skills
Diataxis Docs Writer
calf-ai/calfkit-sdk
Write or improve software documentation using the Diátaxis framework — four documentation types (tutorials, how-to guides, reference, explanation), each serving a different user need.
Docs
brickbots/PiFinder
Author and edit PiFinder's user-facing documentation in the project's house style.
Updating Docs For Release
streamlit/docs
Update the streamlit/docs repo for a new Streamlit release. An agent skill from streamlit/docs.
Doc Writer
pretend1111/claude-desktop-app
Generate README, API docs, or user guides for code and projects.
Diataxis Docs
pmndrs/glyph
Design, classify, write, audit, or restructure technical documentation with the Diátaxis framework.
More from cdiggins/plato
Track Backlog
cdiggins/plato
View and manage the tracker backlog — show in-progress work, current priorities, sprint contents; triage untriaged items; promote ideas to ready; plan a sprint (big rocks + little rocks…
Track Idea
cdiggins/plato
Log a new idea into tracker/ with elaboration — assumptions, design decisions, related work links, approach brainstorm, and simplest implementation.
Track Issue
cdiggins/plato
Log a concrete issue (bug, technical debt, open design problem, or retire candidate) into tracker/ with elaboration — symptoms/impact, affected code links, root-cause notes, fix approaches, and…
Write Docs
cdiggins/plato
Read BEFORE writing or editing any durable document in this repo — docs/.md, stdlib/.md, tracker/readme.md, AGENTS.md, any README.
Related
Categories
Questions about Write Readme
What does Write Readme do?
Write or review a project README.md in plain technical-writer prose — problem it solves and doesn't, honest assessment of tested vs untested, trade-offs, prior art, organization, and usage. Write Readme is an agent skill from cdiggins/plato.md in plain technical-writer prose — problem it solves and doesn't, honest assessment of tested vs untested, trade-offs, prior art, organization, and usage.
When should I use Write Readme?
Write Readme fits situations like: the user says write a README; improve/review the README; document this project; A new project/repo lacks a README.
How do I install Write Readme in Claude Code?
Run `npx skills add cdiggins/plato --skill write-readme -a claude-code`. Or copy the skill folder (.claude/skills/write-readme in cdiggins/plato) into .claude/skills/write-readme in your project. Claude Code loads it when a task matches its description.
How do I install Write Readme in Codex?
Run `npx skills add cdiggins/plato --skill write-readme -a codex`. Or copy the skill folder (.claude/skills/write-readme in cdiggins/plato) into .agents/skills/write-readme in your project. Codex loads it when a task matches its description.
Can I use Write Readme in Cursor, Gemini CLI or GitHub Copilot?
Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add cdiggins/plato --skill write-readme -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/write-readme, .gemini/skills/write-readme, .github/skills/write-readme and .opencode/skills/write-readme in your project.
What does Write Readme need to run?
SKILL.md names no scripts, command-line tools or credentials: Write Readme is instructions for the agent only.
Does Write Readme access the network?
SKILL.md contains no URLs. Any network use would come from the scripts or tools the agent runs. This is read from the text; nothing was executed.
Is Write Readme safe to install?
Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.
What licence does Write Readme use?
Write Readme is published under the MIT licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.
How many tokens does Write Readme use?
About 1.6k tokens (SKILL.md is roughly 6.3k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.
What are the alternatives to Write Readme?
Skills that share tags, products or a category with Write Readme: Technical Writer (finos/morphir, 213 stars), Diataxis Docs Writer (calf-ai/calfkit-sdk, 149 stars), Docs (brickbots/PiFinder, 250 stars) and Updating Docs For Release (streamlit/docs, 178 stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.
Who maintains Write Readme?
cdiggins (a GitHub user) maintains it in cdiggins/plato, which has 106 GitHub stars. The repository holds 5 skills in this directory. The repository was last updated on September 26, 2026.
Source: cdiggins/plato on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.