docs — write documentation in plain language

Every piece of documentation you write or edit must conform to ISO 24495-1 Plain Language. This is not a preference or a house style you can trade away. If a sentence does not meet the standard, rewrite it before you save the file. The rule covers new pages, edits to existing pages, and any prose you add to a repository: READMEs, guides, tutorials, reference pages, release notes, changelogs, and doc comments.

Purpose

ISO 24495-1 is the first international standard for plain language. Its goal is to help writers create documents that readers can find, understand, and use effectively.

Definition of plain language

A document uses plain language when its wording, structure, and design enable the intended audience to: