Skip to content

Commit 9a91dad

Browse files
authored
Added writing principles (#17392)
1 parent bd3e775 commit 9a91dad

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

handbook/company/communications.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -712,7 +712,9 @@ Learn how to communicate as Fleet with guidelines for tone of voice, our approac
712712
- Infuse the core [values](https://fleetdm.com/handbook/company#values) into everything you write.
713713
- Read and reread, then rewrite to make it shorter. Use links rather than explanations, short sentences.
714714
- Get to where you feel like it’s really good, short, simple, and clear, hack away at any word that’s too confusing.
715-
- Don’t sound formal, sound welcoming so that anyone can understand. Translate "[puffery](https://www.linkedin.com/pulse/puffery-adam-frankl%3FtrackingId=SBVWxzqXTBm9qlO7Rw3ddw%253D%253D/?trackingId=SBVWxzqXTBm9qlO7Rw3ddw%3D%3D)" into "ease of use" or "readability".
715+
- Don’t sound formal, sound welcoming so that anyone can understand. Translate "[puffery](https://www.linkedin.com/pulse/puffery-adam-frankl%3FtrackingId=SBVWxzqXTBm9qlO7Rw3ddw%253D%253D/?trackingId=SBVWxzqXTBm9qlO7Rw3ddw%3D%3D)" into "ease of use" or "readability".
716+
- Disarm puffery for engineers by replacing puffery with real data.
717+
- Disarm puffery for the business by replacing puffery with ROI/RTO (how much time and/or money is it going save the business? Forget the details. When will it pay itself back?)
716718
- Apply the advice about writing linked from the company values (the [Paul Graham](http://www.paulgraham.com/simply.html) essays).
717719
- Create headings that make good permalinks, use links and add missing links. Indicate links by highlighting words that describe the content (Better SEO than lighting up “click here”).
718720
- Don’t duplicate content, link to other places like the [values](https://fleetdm.com/handbook/company#values) or [“why this way”](https://fleetdm.com/handbook/company/why-this-way#why-this-way), but don’t make it awkward.

0 commit comments

Comments
 (0)