from Hacker News

Ritza's Styleguide for Technical Writing

by sixhobbits on 1/16/25, 2:33 PM with 2 comments

  • by WCSTombs on 1/16/25, 8:55 PM

    I briefly clicked around and haven't read everything yet, but from a first impression, this looks pretty good.

    Sadly it looks like the "Process" heading is just a stub, which is a bummer because that's one of the things I'm most looking forward to improving, and I'm guessing that's true for many. What I've found is that in my technical writing, often I just start writing and at some point the document becomes badly organized in a subtle way that's difficult for me to see, but then I do a big rewrite of sorts and it's much better the second time around.