Consider tech edits to README per MSFT contributor accessibility guidelines

microsoft / bonsai-cstr

Project Bonsai Sample for Continuous Stirred Tank Reactor (CSTR)

MIT License

8 stars 10 forks source link

Consider tech edits to README per MSFT contributor accessibility guidelines #4

Open scotstan opened 2 years ago

scotstan commented 2 years ago

prefer active vs passive (passive adds cognitive noise) one idea per sentence no pronouns (this, that, you, we, rarely "it") "you" best in side-bars "you might get an error if..." no gender pronouns (he, she, they); prefer roles "the systems engineer" avoid possessive (ESL) avoid contractions (It's, hadn't) avoid posessives (ESL, unique to English?) (Its)