Yan Cui on Better Writing

Taken from https://twitter.com/theburningmonk/status/1714159389496479856?s=20 and worth a summary in not-so-Twitter-format.

๐—ฆ๐—ฒ๐—น๐—น ๐˜๐—ต๐—ฒ ๐—ฝ๐—ฟ๐—ผ๐—ฏ๐—น๐—ฒ๐—บ, ๐—ป๐—ผ๐˜ ๐˜๐—ต๐—ฒ ๐˜€๐—ผ๐—น๐˜‚๐˜๐—ถ๐—ผ๐—ป

Like that scene in The Wolf of Wall Street where Di Caprio asked Jon Bernthal to sell him a pen. First, create the demand, then supply the solution.

Sell the problem to the reader. Help them understand why itโ€™s a problem worth solving. If the readers are not interested in the problem you’re solving, they won’t care about whatever solution you propose, no matter how good the solution is.

Be explicit about what “good” looks like

Explain what a “good” solution means to you and your rationale before diving into describing your solution.

Finish off with the ๐˜๐—ฟ๐—ฎ๐—ฑ๐—ฒ-๐—ผ๐—ณ๐—ณ๐˜€ and what context your solution worked in (e.g. high throughput API).

Everyone’s mileage is different and your readers likely care about different qualities to you. Communicating WHY you think a solution is good and WHEN it’s a good fit helps readers understand your way of thinking and judge whether or not it’s also a good fit for them.

Also, it’s important to define this “goodness” up front. It helps combat cognitive biases that we all have, such as confirmation bias. Defining โ€œgoodโ€ ahead of time helps keep us honest with ourselves.

๐—ž๐—ฒ๐—ฒ๐—ฝ ๐—ถ๐˜ ๐˜€๐—ต๐—ผ๐—ฟ๐˜, ๐—ธ๐—ฒ๐—ฒ๐—ฝ ๐—ถ๐˜ ๐—ฐ๐—ผ๐—ป๐—ฐ๐—ถ๐˜€๐—ฒ

Don’t linger with your words, remove paddings and fluffs. Attention spans are short and precious

๐—ฃ๐˜‚๐˜ ๐˜๐—ต๐—ฒ ๐—ฏ๐—ถ๐—ด ๐—ถ๐—ฑ๐—ฒ๐—ฎ ๐˜‚๐—ฝ๐—ณ๐—ฟ๐—ผ๐—ป๐˜

Eric Evans once told me that he regretted introducing ubiquitous language and other big DDD ideas in the 2nd half of his book. Most people only read the 1st half and think DDD is all about the repository & entity patterns.

Another reason for putting the good stuff out first is to help you start strong and grab ๐—ฒ๐—ฎ๐—ฟ๐—ป the reader’s attention so you can spend them on the nitty-gritty technical details later. The reader’s attention is a currency, and you do have to earn it first.

๐—ฃ๐—ถ๐—ฐ๐˜๐˜‚๐—ฟ๐—ฒ ๐˜€๐—ฎ๐˜†๐˜€ ๐—ฎ ๐˜๐—ต๐—ผ๐˜‚๐˜€๐—ฎ๐—ป๐—ฑ ๐˜„๐—ผ๐—ฟ๐—ฑ๐˜€

But not all pictures are created equally, so choose them wisely. And don’t overdo it

Mind the “curse of expertise”

Always remember that you are the expert in your domain. When you share knowledge & experience, you need to be mindful of what assumptions youโ€™re making of the reader. In the immortal words of Simon Sinek, always start with why (see tip no. 1ย 

Be honest

Goes without saying.

Use simple language

The goal is not to look smart, the goal is to convey your big idea to the reader with minimal loss of precision. Complex sentence structure gets in the way of absorption. Hemingway is a great tool to help with this.ย https://hemingwayapp.com

Leave a comment

This site uses Akismet to reduce spam. Learn how your comment data is processed.