Hacker News new | past | comments | ask | show | jobs | submit login

Anyone got some favorite examples of great technical writing?

Stripe gets a lot of love, but I think React's tutorials are also wonderful: https://reactjs.org/docs/hello-world.html

They did a stellar job of slowly building technical concepts before hitting you with bigger concepts like managing state.




I've always been fond of Svelte. Their reference docs are great, but their tutorial really shines: https://svelte.dev/tutorial/basics. Each step provides a working example next to the documentation, allowing you to figure it out before clicking the "Show me" button for help.


I think the Cypress documentation is absolutely great:

https://docs.cypress.io/

One of the better things about cypress are how they create so many how-to guides for a variety of scenarios. Take implementing Cypress into a CI runners, they have guides on how to effectively use it nearly everywhere:

https://docs.cypress.io/guides/continuous-integration/ci-pro...


I really liked the Just README recently: https://github.com/casey/just/blob/master/README.md


I was looking for a table of contents, and eventually realized the hint pointing to the top left.

Really simple, minimal way to handle your table of contents inline, versus constantly updating links at the top of the page.


I use GitHub dozens, maybe hundreds of times each work day. I never noticed this ToC button until your comment. I am impressively UI blind.


I think that feature was added some time in the last six months.


Matlab has some pretty great documentation.




Consider applying for YC's Spring batch! Applications are open till Feb 11.

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

Search: