Write Good

Write Good is a linter or style checker for English prose, designed to help developers and technical writers improve the clarity, conciseness, and readability of their documentation, comments, and other written content. It analyzes text for common issues like passive voice, weasel words, adverbs, and complex phrases, providing suggestions to make writing more direct and effective. It is often integrated into development workflows, such as in code editors or CI/CD pipelines, to enforce good writing practices.

Also known as: write-good, writegood, write-good-linter, prose-linter, english-linter

Why learn Write Good?

Developers should learn and use Write Good when they need to produce high-quality documentation, README files, API descriptions, or code comments that are easy for others to understand, which is crucial for collaboration and maintainability in software projects. It is particularly valuable in open-source projects, technical writing roles, or teams aiming to standardize writing quality, as it automates feedback on common writing pitfalls, saving time and reducing errors compared to manual proofreading.

Learning Resources

• docs: Write Good GitHub Repository
• tutorial: How to Use Write Good for Better Documentation
• article: Improving Your Writing with Linters
• docs: Write Good npm Package Documentation