Writing Technical Documents Well

Re:Writing Technical Documents Well by rramadass on Tuesday August 20, 2024 @11:09AM (#41300776)

For Technical Writing, follow "The Minto Pyramid Principle" (https://untools.co/minto-pyramid/), keep everything Concise, Precise, use Assertive/Definitive voice and show Usage with Examples in the beginning itself.

[ Parent | on HN ]

Re:Writing Technical Documents Well by zodvik on Tuesday August 20, 2024 @11:15AM (#41300824)

At Stripe, this was also framed as BLUF - bottom line up front.

[ Parent | on HN ]

Re:Writing Technical Documents Well by rramadass on Tuesday August 20, 2024 @11:21AM (#41300880)

BLUF is a Military standard; see article linked to under the "sources" section of the above link.

[ Parent | on HN ]