←back to thread

Red Hat Technical Writing Style Guide

(stylepedia.net)
265 points jumpocelot | 1 comments | 10 Jul 25 15:01 UTC | HN request time: 0.248s | source
Show context
freedomben ◴[10 Jul 25 17:09 UTC] No.44523137[source]▶
Wow, this is a really terrific guide. It's quite long, but it's long because of it's breadth, not because of being overly verbose (IMHO). I particularly appreciate the clear explanations and large number of examples that really help make the concept more concrete. I think this is quite broadly useful even for people that don't work for Red Hat.
replies(1): >>44531104 #
1. Cthulhu_ ◴[11 Jul 25 11:54 UTC] No.44531104[source]▶
Yeah it reads like one to file away if I ever end up doing a lot of technical documentation. In this case, it's a guide that is aimed at an army of people (dozens? Hundreds? I don't even know, Red Hat has 19.000 employees) writing documentation as their day job. That is, I wouldn't be at all surprised if just the number of people writing documentation for RH is more than the number of engineers we have at my current employer (one of the major energy companies in the Netherlands).