News for hackers. Stuff that matters.
Re:Technical Writing for Developers by lelandfe on Friday July 15, 2022 @02:21PM (#32111237)
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.

Re:Technical Writing for Developers by deckard1 on Friday July 15, 2022 @04:06PM (#32112187)
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.
Re:Technical Writing for Developers by azemetre on Friday July 15, 2022 @03:29PM (#32111871)
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...

Re:Technical Writing for Developers by simonw on Friday July 15, 2022 @02:26PM (#32111296)
I really liked the Just README recently: https://github.com/casey/just/blob/master/README.md
Re:Technical Writing for Developers by sam1r on Friday July 15, 2022 @05:31PM (#32113031)
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.

Re:Technical Writing for Developers by lelandfe on Friday July 15, 2022 @07:48PM (#32113957)
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.
Re:Technical Writing for Developers by simonw on Saturday July 16, 2022 @01:33AM (#32115483)
I think that feature was added some time in the last six months.
Re:Technical Writing for Developers by thfuran on Friday July 15, 2022 @11:56PM (#32115099)
Matlab has some pretty great documentation.