write-good English Prose Linting for Technical Content

write-good English Prose Linting for Technical Content

This skill uses write-good to flag vague, wordy, or hard-to-read English prose in documentation and content drafts. It is useful when a team wants lightweight style feedback inside editors, scripts, or CI checks.

Installation

Use the upstream install or setup path that matches your environment:

• npm install write-good
• npm install -g write-good
• If you have npm version 5.2.0 or later installed, you can use npx to run write-good without installing it:
• npx write-good *.md

Requirements and caveats from upstream:

• var writeGood = require('write-good');
• var schreibGut = require('schreib-gut');
• write-good takes a glob and prints suggestions to stdout:

Basic usage or getting-started notes:

• Like this, you can check non-English documents, for example with the linter extension for German, schreib-gut:

• For example, normally only would be picked up as a bad word to use, but you might want to exempt read-only from that:

• You can run just specific checks like this:

• Source: https://github.com/btford/write-good

• Extracted from upstream docs: https://raw.githubusercontent.com/btford/write-good/HEAD/README.md

Source

• Agent Skill Exchange