Hacker Newsnew | past | comments | ask | show | jobs | submitlogin

There is an important aspect of writing architectural docs (or any docs for that matter) that is often overlooked.

Write simply and clearly.

Too much verbosity and detail is difficult to follow. That's what the code is for. It is almost a superpower to be able to write succinctly and clearly. This isn't some contest to showoff your deep knowledge of a particular niche. I've seen developers get 'nerdy' with their docs for a lack of a better term.



+1

One trick here is to keep in the source, every sentence on a separate line. That way, it's hard to miss complicated sentences. As a bonus, docs become easier to diff.

rust-analyzer does this: https://raw.githubusercontent.com/rust-analyzer/rust-analyze...




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

Search: