Agent skill

Nbj Write Clearly

by daniel-p-green in daniel-p-green/nbj-write-clearly

Drafts, revises, and audits reader-first technical and product documentation.

MITAuto-check passedWriting & Content

Install Nbj Write Clearly

skills CLI
$ npx skills add daniel-p-green/nbj-write-clearly --skill nbj-write-clearly -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install daniel-p-green/nbj-write-clearly nbj-write-clearly --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/daniel-p-green/nbj-write-clearly.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.agents/skills/nbj-write-clearly .claude/skills/nbj-write-clearly && rm -rf skills-src

Use ~/.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/

Facts

Skill name
nbj-write-clearly
GitHub stars
117
Token cost
~1.1k tokens
SKILL.md length
550 words
Files
4 (incl. references)
Skills in repo
1
Repo updated
First seen
Licence
MIT

At a glance

Drafts, revises, and audits reader-first technical and product documentation.

  • Works in 5 steps: Follow the user's explicit request and… → Preserve source facts, quotations, code,… → Follow project-specific style. → …
  • Working on developer docs
  • SKILL.md covers Outcome, Apply the right authority, Write or revise and Protect meaning and voice, plus 1 more section
  • Instructions only: no scripts, shell commands, URLs or credentials in SKILL.md

What it does

Nbj Write Clearly is an agent skill from daniel-p-green/nbj-write-clearly. Drafts, revises, and audits reader-first technical and product documentation. Use when working on developer docs, procedures, release notes, technical explanations, help-center content, or UI copy where clarity, source fidelity, accessibility, or global readability matters. Do not auto-apply it to marketing, legal, academic, fictional, or personal writing unless the user explicitly requests this style.

Its SKILL.md is about 1.1k tokens, which your agent loads only when the skill is triggered. The skill folder holds 5 other files, including reference files (for example `agents/openai.yaml`, `references/guide.md` and `references/official-index.md`).

It sits in Writing & Content, covering Plain language and style rules, Technical writing and Help center and FAQ content. The repository describes itself as: A clear-writing agent skill grounded in the Google Developer Documentation Style Guide. The licence is MIT.

When your agent uses it

  • Working on developer docs
  • Technical explanations
  • Help-center content
  • UI copy where clarity

Example prompts

  • “/nbj-write-clearly”

Workflow steps

5 steps, taken from the first numbered list in SKILL.md.

  1. Follow the user's explicit request and the destination's requirements.
  2. Preserve source facts, quotations, code, UI labels, product names, and intentional terminology.
  3. Follow project-specific style.
  4. Apply this skill's Google-derived guidance.
  5. Consult other references only when the preceding sources are silent.

What it can do on your machine

Read from SKILL.md and the folder at commit 56e3a27. 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

Nbj Write Clearly loads about 1.1k tokens when it runs, and up to ~3.8k if it reads all its reference files. Until then it costs about 106 tokens; SKILL.md has 550 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~106
When it runs · the whole SKILL.md, loaded when a task matches
~1.1k
With references · SKILL.md plus every file in references/, read only if the agent opens them
~3.8k

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 daniel-p-green/nbj-write-clearly at commit 56e3a27, republished under its MIT licence (© daniel-p-green). 550 words, ~1,085 tokens.

Download SKILL.mdSave it as .claude/skills/nbj-write-clearly/SKILL.md (or your agent's skills folder). This skill also uses 3 other files; get the full folder from GitHub.
name
nbj-write-clearly
description
Drafts, revises, and audits reader-first technical and product documentation. Use when working on developer docs, procedures, release notes, technical explanations, help-center content, or UI copy where clarity, source fidelity, accessibility, or global readability matters. Do not auto-apply it to marketing, legal, academic, fictional, or personal writing unless the user explicitly requests this style.

NBJ Write Clearly

Outcome

Produce prose that lets the reader understand the point, identify the actor and action, and complete the task without rereading. Preserve the author's facts, intent, uncertainty, and useful voice.

Apply the right authority

Use this order of precedence:

  1. Follow the user's explicit request and the destination's requirements.
  2. Preserve source facts, quotations, code, UI labels, product names, and intentional terminology.
  3. Follow project-specific style.
  4. Apply this skill's Google-derived guidance.
  5. Consult other references only when the preceding sources are silent.

Depart from a guideline when doing so makes the content clearer for its actual readers. Stay consistent after making that choice.

Write or revise

  1. Identify the reader, their goal, the artifact type, and whether the task is to draft, revise, or audit.
  2. Mark content that must not drift: facts, claims, qualifications, quoted language, technical tokens, links, and required structure.
  3. Put the result or purpose first. Give each paragraph one idea and put critical information early.
  4. Name the actor. Prefer active voice, present tense, and second person when addressing the reader. Use imperatives for steps.
  5. Put a condition or circumstance before the instruction it controls.
  6. Prefer familiar, precise words. Define necessary jargon or abbreviations on first use. Keep one term for one concept.
  7. Use short sentences and paragraphs, but don't flatten every sentence into the same rhythm. Use common contractions when they sound natural.
  8. Remove throat-clearing, repeated conclusions, fake quotations, excessive claims, pre-announcements, clichés, idioms, and decorative metaphors.
  9. Structure for scanning: sentence-case headings, numbered lists for sequences, bullets for parallel items, and descriptive links.
  10. Read references/guide.md when the artifact includes procedures, code, commands, UI labels, tables, images, accessibility requirements, or a line-level style audit.
  11. Read references/official-index.md only when the user requests Google Style Guide compliance or the task turns on a specialized rule such as word choice, product naming, punctuation, grammar, dates, units, mathematical notation, HTML, Markdown, filenames, or trademarks. Consult only the relevant official page when browsing is available.
Show full SKILL.md (214 more words)Show less

Protect meaning and voice

  • Do not add facts, certainty, praise, urgency, or product claims.
  • Preserve source modality such as can, might, should, and will. Do not change it only to satisfy a tense preference.
  • Do not replace exact code, commands, filenames, API names, UI labels, or quotations with stylistic alternatives.
  • Do not rewrite when the user asked only for an audit. Report findings in priority order and give bounded examples.
  • Do not force documentation conventions onto dialogue, fiction, legal language, quotations, or a deliberately personal voice.
  • Do not make prose childish or robotic in the name of simplicity. Prefer the clearest accurate term, even when it is technical.

Validate

Before returning the result, check that:

  • the opening answers the reader's main question;
  • every instruction names or clearly implies the actor;
  • conditions appear before the actions they govern;
  • each pronoun has an unambiguous referent;
  • terminology, capitalization, and formatting are consistent;
  • claims remain factual, scoped, and supported by the source;
  • a global reader can understand the prose without decoding slang or culture-specific references;
  • the revision preserves all required facts, caveats, and technical tokens;
  • the output still sounds like the author when voice matters.

Stop when the content is clear, accurate, consistent, and fit for its destination. Do not keep polishing lines that already do their job.

© daniel-p-green, MIT. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

SKILL.md and 3 other files (references) in .agents/skills/nbj-write-clearly of daniel-p-green/nbj-write-clearly.

  • SKILL.md
  • agents/openai.yaml
  • references/guide.md
  • references/official-index.md

Open the folder on GitHubat commit 56e3a27

Compare with similar skills

Nbj Write Clearly 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.

Nbj Write Clearly compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Nbj Write Clearly this skilldaniel-p-green/nbj-write-clearly117—~1.1kAutomated safety check: PassMIT
Technical Writingcitypaul/.dotfiles740—~2.5kAutomated safety check: PassMIT
Mintlify Claude Docslilinji/ai-infra-odyssey130—~8.2kAutomated safety check: PassNone
Technical Writing Standardcursor/plugins11k10 repos~2.4kAutomated safety check: PassNone
UX Writingcontent-designer/ux-writing-skill2241 repos~3.8kAutomated safety check: PassMIT
Chinese Technical Writingleter/zh-tech-writing352—~656Automated safety check: PassMIT

Similar skills

  • Technical Writing

    citypaul/.dotfiles

    Writing developer-facing prose that can be skimmed first and trusted enough to finish — READMEs, guides, tutorials, reference docs, proposals, PR descriptions, release notes.

    740 GitHub stars~2.5k tokensUpdated yesterday
    Writing & ContentAuto-check passed
  • Mintlify Claude Docs

    lilinji/ai-infra-odyssey

    Build, write, review, migrate, and maintain Mintlify documentation in a restrained Claude Docs-inspired style.

    130 GitHub stars~8.2k tokensUpdated 11 days ago
    Writing & ContentAuto-check passed
  • Official

    Applies four layers of technical-writing rules to docs, RFCs, readmes, PR descriptions and commit messages so a tired engineer follows them on the first read.

    11k GitHub starsUsed in 10 repos~2.4k tokens
    Writing & ContentAuto-check passed
  • UX Writing

    content-designer/ux-writing-skill

    Applies UX writing practice to interface copy such as buttons, errors, forms and onboarding, using four quality standards and accessibility guidance.

    224 GitHub starsUsed in 1 repo~3.8k tokens
    Writing & ContentAuto-check passed
  • Chinese Technical Writing

    leter/zh-tech-writing

    Sets writing rules for Chinese technical docs: short plain sentences, consistent typography and a checklist for removing AI-sounding filler.

    352 GitHub stars~656 tokensUpdated 15 days ago
    Writing & ContentAuto-check passed
  • Plain English

    Fallout-build/Fallout

    Write clear, plain English for developer-facing prose aimed at an international audience.

    167 GitHub stars~2k tokensUpdated today
    DevelopmentAuto-check passed

Questions about Nbj Write Clearly

What does Nbj Write Clearly do?

Drafts, revises, and audits reader-first technical and product documentation. Nbj Write Clearly is an agent skill from daniel-p-green/nbj-write-clearly. Drafts, revises, and audits reader-first technical and product documentation.

When should I use Nbj Write Clearly?

Nbj Write Clearly fits situations like: working on developer docs; technical explanations; help-center content; UI copy where clarity.

How do I install Nbj Write Clearly in Claude Code?

Run `npx skills add daniel-p-green/nbj-write-clearly --skill nbj-write-clearly -a claude-code`. Or copy the skill folder (.agents/skills/nbj-write-clearly in daniel-p-green/nbj-write-clearly) into .claude/skills/nbj-write-clearly in your project. Claude Code loads it when a task matches its description.

How do I install Nbj Write Clearly in Codex?

Run `npx skills add daniel-p-green/nbj-write-clearly --skill nbj-write-clearly -a codex`. Or copy the skill folder (.agents/skills/nbj-write-clearly in daniel-p-green/nbj-write-clearly) into .agents/skills/nbj-write-clearly in your project. Codex loads it when a task matches its description.

Can I use Nbj Write Clearly 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 daniel-p-green/nbj-write-clearly --skill nbj-write-clearly -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/nbj-write-clearly, .gemini/skills/nbj-write-clearly, .github/skills/nbj-write-clearly and .opencode/skills/nbj-write-clearly in your project.

What does Nbj Write Clearly need to run?

SKILL.md names no scripts, command-line tools or credentials: Nbj Write Clearly is instructions for the agent only.

Does Nbj Write Clearly 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 Nbj Write Clearly 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 Nbj Write Clearly use?

Nbj Write Clearly 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 Nbj Write Clearly use?

About 1.1k tokens (SKILL.md is roughly 4.3k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full. Its references folder adds about 2.7k tokens, read only when the agent opens those files.

What are the alternatives to Nbj Write Clearly?

Skills that share tags, products or a category with Nbj Write Clearly: Technical Writing (citypaul/.dotfiles, 740 stars), Mintlify Claude Docs (lilinji/ai-infra-odyssey, 130 stars), Technical Writing Standard (cursor/plugins, 11k stars) and UX Writing (content-designer/ux-writing-skill, 224 stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Nbj Write Clearly?

daniel-p-green (a GitHub user) maintains it in daniel-p-green/nbj-write-clearly, which has 117 GitHub stars. The repository was last updated on August 18, 2026.

Source: daniel-p-green/nbj-write-clearly on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.