Skip to content
This repository has been archived by the owner on Sep 13, 2021. It is now read-only.

Latest commit

 

History

History
34 lines (20 loc) · 1.04 KB

writing.md

File metadata and controls

34 lines (20 loc) · 1.04 KB

An evolving set of guidelines for writing well

See also: jenniferlynparsons/awesome-writing

Articles

Words to watch

Word Possible replacements
introduce add
multiple many
potential possible
unnecessary useless, pointless
in order to verb to verb
you need to verb verb

Clichés when describing a GitHub repository

Size: tiny, small, minuscule, lightweight . Can also include the size in kilobytes (with the GZIPped size in parantheses).

Level of abstraction goes from close to the metal to for Humans.

Speed / efficiency: fast (also blazing-fast), efficient. Optionally includes 🚀 (rocket emoji) or ⚡️ (lightning emoji).

Configuration / setup: is not mentioned unless it's zero config, in which case it just works.

Freshness: modern.

Flexibility: goes from non-opinionated to opinionated.