[HN Gopher] Writing for Engineers ___________________________________________________________________ Writing for Engineers Author : isomorphy Score : 73 points Date : 2022-04-29 21:54 UTC (1 days ago) (HTM) web link (www.heinrichhartmann.com) (TXT) w3m dump (www.heinrichhartmann.com) | open-source-ux wrote: | Lots of good advice in this post. | | I also find the 10 tips for clear writing at the following link | very helpful - it overlaps with some of the advice in the post | above - and includes some additional suggestions: | | https://gds.blog.gov.uk/2019/08/27/podcast-on-writing/ | | You don't need to listen to the podcast at the top of the page | above (unless you want to). Instead, scroll down the page and | you'll find a short description of each of the following tips. | | 1. Establish 'The Point' | | 2. Write it like you'd say it | | 3. Don't try to sound clever | | 4. Show the thing | | 5. Know that you are not your writing | | 6. Share your work | | 7. Read (poetry in particular) | | 8. Never start with a blank page | | 9. Know when enough is enough | | 10. Stay human | criddell wrote: | If I were editing the article being discussed, I think I'd | suggest getting rid of the first three introductory paragraphs. | I think it'sokay to assuming the reader already agrees writing | is important. | d4a wrote: | Cool post, is there an RSS feed? | [deleted] | alimov wrote: | > Know your audience | | This point is something that I notice in a lot of meetings. Some | of the engineers I work with are long winded and tend to over- | explain concepts/issues to non-engineering folks. I try to send a | direct message during the meeting (now and then) to try and reel | them in a little by explaining that the non-engineering folks | don't need those details and that a what they are really asking | for is a summary of the key points of the concept/issue under | discussion, but it's not always well received. | dwenzek wrote: | This post is a pearl! I love writing and I think that I'm good at | it. However, I still have to learn and this post gives a sound | structure. The point I'm struggling the most is to help my | teammates growing their writing skills and to make them love | writing. I will definitely recommend them this post! | madeofpalk wrote: | > your are not ready | | heh. Ironic. | | Everyone makes silly mistakes. Just mildly funnier when it | happens in an article about "how to writes good" | | While we're on topic of annoying besides-the-point HN pedantry, I | find the use of blockquotes in this article to be distracting. | What are they quoting? They seem to be more of an aside than an | actual quote? ___________________________________________________________________ (page generated 2022-04-30 23:00 UTC)