NBJ Write Clearly skill
A skill that drafts, revises and audits technical docs by the Google Developer Documentation Style Guide while protecting facts.
- 120 ★ on the repository
- Last commit
- MIT
Minimal access
Why this level
- The skill consists of instructions and reference files with no code execution.
Install
- Works in
In your terminal, with SkillFoxx CLI
npx skillfoxx add skills/nbj-write-clearlyDetects the agents on your machine, shows the access level and pins the version.
Other ways to install
Access and checks
How we reviewMinimal accessThe tool runs nothing and makes no network calls.
- The skill consists of instructions and reference files with no code execution.
This is third-party code. Review the repository files before installing.
What it does
NBJ Write Clearly guides an agent through revising or auditing documentation: the answer to the reader comes first, actors are named and conditions precede steps. Commands, filenames, APIs, UI labels, modal verbs and quotations stay unchanged. The skill can draft from scratch, rewrite a draft or only audit without rewriting. A compact `SKILL.md` holds the workflow, and reference files load on demand and point to the relevant Google guide pages.
Who it is for. Technical writers and developers who write procedures, release notes and UI copy and want checks that keep the meaning intact.
Good fit when
- A README draft with steps in the wrong order must become a clear procedure.
- Release notes are audited without rewriting and a list of the biggest problems comes back.
- UI copy is shortened while button names remain as they are.
- An API explanation for an international audience is simplified without losing accuracy.
Not a fit when
- You are writing marketing, legal, academic or fiction text.
- You need a single brand voice: the skill follows the Google guide.
- You need Russian spell checking: it is based on an English-language guide.
Example request
Use nbj-write-clearly to audit this install procedure: list the main clarity problems but do not rewrite the text.Limitations
The skill is unofficial and does not reproduce the whole Google guide: it operationalizes core principles and routes rare cases to live pages. The author reviewed 70 guide pages in August 2026. The rules are primarily English. The last commit is from August 2026. The skill does not replace an editor and is an aid: style decisions about product, terms and audience stay with the author. The rules and examples are primarily English, so Russian text still needs a manual read-through.
How to disable. Delete the `nbj-write-clearly` folder from `~/.codex/skills/` or `~/.agents/skills/`, then start a new task so the agent refreshes its skill list.
FAQ
How do I call it?
Name it in the request, for example `$nbj-write-clearly`, or let the agent pick it: the description covers docs, procedures and release notes.
What does it leave untouched?
Facts, caveats, commands, filenames, API and product names, UI labels, quotations and modal verbs stay as written.
Can it only audit?
Yes. Ask for an audit without rewriting and the agent reports the highest-risk clarity problems.
What is in the repository?
`SKILL.md`, a `guide.md` reference, an `official-index.md` of official pages, an OpenAI config and `scripts/check.sh`.
How is it not a generic simplifier?
The skill decides what to preserve, what to change and when to stop editing instead of shortening everything.
Discussion
No questions or reviews yet.
Related
SkillsAn editing skill that strips stock AI phrasing but keeps the author's vocabulary, rhythm and bluntness, not a flat style.
A skill that makes an agent write docs and replies in plain English on ASD-STE100 rules: short sentences, one term per meaning, condition before command
A skill for writing and revising ML, CV and NLP papers: section structure, paragraph flow and reviewer-style self-review
A skill for Chinese technical writing: rewrites docs, interface strings and API descriptions, keeps the facts intact and checks output with a linter
A skill that rewrites dense, ambiguous English into ASD-STE100 Simplified Technical English so another agent cannot misread it
Strunk's 1918 writing rules for an agent: the skill applies them to documentation, commit messages and error text
Comparison with similar tools
Cards that share the main search query, and how they differ.
| Tool | Official | Repository stars | Main difference |
|---|---|---|---|
| NBJ Write Clearly (this card) | no | 120 | |
| technical-writing | no | 219 | a general technical writing rule set; this skill is built on the Google guide and protects facts and author voice |
| zh-tech-writing | no | 415 | technical writing rules in Chinese; this uses the English Google guide with an audit-only mode |
README in short
It grew from the idea of turning the Google guide into an agent skill. Candidate comparison and a forward test are described in `EVALUATION.md`.