5 ms·

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/

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 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.

simonw 4y ago
I really liked the Just README recently: https://github.com/casey/just/blob/master/README.md https://github.com/casey/just/blob/master/README.md
- sam1r 4y ago
  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.
  - lelandfe 4y ago
    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.
    - simonw 4y ago
      I think that feature was added some time in the last six months.
azemetre 4y ago
I think the Cypress documentation is absolutely great: https://docs.cypress.io/ 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-provider-examples#Guides https://docs.cypress.io/guides/continuous-integration/ci-pro...
deckard1 4y ago
I've always been fond of Svelte. Their reference docs are great, but their tutorial really shines: https://svelte.dev/tutorial/basics 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.
thfuran 4y ago
Matlab has some pretty great documentation.

simonw 4y ago

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

sam1r 4y ago
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.
- lelandfe 4y ago
  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.
  - simonw 4y ago
    I think that feature was added some time in the last six months.

azemetre 4y ago

I think the Cypress documentation is absolutely great: https://docs.cypress.io/ 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-provider-examples#Guides https://docs.cypress.io/guides/continuous-integration/ci-pro...

deckard1 4y ago

I've always been fond of Svelte. Their reference docs are great, but their tutorial really shines: https://svelte.dev/tutorial/basics 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.

thfuran 4y ago

Matlab has some pretty great documentation.