Writings
1 min read
Updated:
Blog Posts
- Don’t restate the theories, or something that could be googled in a minute. Instead, focus on some unique insights or questions to be answered.
- Uses point form to state multiple facts or opinions that don’t need to be elaborated, while uses paragraphs to explain some ideas in detail.
- Uses examples, simulations, equations, plots, diagrams, or code snippets to illustrate the ideas whenever possible.
- Links are fantastic, but they should never be the only piece of information in the answer. discussion
Design Documents
- My Techlead Roasted Me
- Design Docs at Google
- Technical Writing — Google
- API design guide — Google
- Writing guidelines — mdn web docs
Documentation
Good examples
- Whats the best documentation youve ever seen? — Reddit
- awesome-documentation
- Rust Book
- mdn web docs
- tailwindcss
- astro
- GitLab Docs
- auth0
- TutorialCachingStory — memcached