Hacker News new | past | comments | ask | show | jobs | submit | more maxekman's comments login

A bit like code then, optimize for easy reading rather smarts when writing it.


Cool tip! However I don’t think I would have the motivation to do a good job in that (and sadly no time for it).


No worries! Just threw it out there in case it might fit in with your goals.


Really cool tip!


Really good suggestion, I have not been very active commenting here. Thanks!


Very true that we sit by our screens way too much. Any reasonable work away from it is probably for the best. On this note I would like to share a really good tip (but slightly out of topic) that I got in the comments on some HN post some time ago; don’t use your phone or Internet until late morning, or at least after having really dug in to work for the day. This really helps to focus on the work at hand and avoid distractions.


Getting into "work mode" really helps. I did a similar thing during my Ph.D. studies - no reading email or news or gaming until lunch time, only work. After lunch, all options were open, but I then had work so swapped in that I kept on working.


Love your tip of how to structure a text. Thanks!


Good suggestion! Do you have any technical docs that stand out as extra good in your opinion?


I remember the Ansible docs as pretty good.

I’m sure you have read those great todo articles on medium or log rocket or whatever.

The problem with citing good professional documentation is that this is usually or inevitably taken on by a team, so docs are really a standard of a good editor.

The problem with stuff in the wild is it can be too bloggy or conversational.

What you need is awareness and purpose. Stop reading junk as soon as you identify it (skim junk for take always ;).

Cherish and reread somethings that “speak to you.”

Ironically, the best technical documentation is dry and to the point (without sounding as though generated from already inadequate code comments [glare].)

Edit out sarcasm, sentiments, and unnecessary references or language.

Explain what is happening, show an example and stop. You’ll do fine!

Do read one of those boring grammar/punctuation books. Just being aware of good sentence form will make you a better writer.

I did all this stuff over a decade ago, so I don’t have a link off hand.


Stripe is very often mentioned as an example of great docs - https://stripe.com/docs


Thanks! Will definitely check that out. I know I have stumbled in there before, but not having used the service I have not really looked around too much.


K&R, or anything else Brian Kernighan.


I had to look up what K&R was but makes sense after some searching. That book is probably worthwhile for lots of other reasons, even if I program in Go for most tasks. Thanks for the pointer!


Thanks for the literature tips, will definitely get one of the books right away. Will also learn more about Practical Style as I haven’t heard about that.


Shameless plug for my employer Einride. We are building a almost driverless truck (AD with remote safety driver). Really cool company to work for.

https://www.einride.tech/pod

Edit: Driverless clarification.


The CB808 eurorack module from Tiptop Audio is almost a perfect replica I believe: https://tiptopaudio.com/808-2/#cb808


Consider applying for YC's Summer 2025 batch! Applications are open till May 13

Guidelines | FAQ | Lists | API | Security | Legal | Apply to YC | Contact

Search: