What is Reddit's opinion of IBM Style Guide, The: Conventions for Writers and Editors (IBM Press)?

From 3.5 billion Reddit comments

> I'm assuming you work for Red Hat? That's cool. :)

That's right, and it is cool :-)

> The $ means a normal prompt, and # means super user or root, right?

Exactly. And if the current directory, the current user, or the specific machine matter for the command (which they rarely do), we could specify it like this, modifying the default Bash prompt:

/some/directory]$ command [user@system /some/directory]$ command

> How do you format the text if it includes a variable?

A hotly debated issue! Some of our documentation uses italics for that (variable), other places use pointy brackets (<variable>), capitals (VARIABLE), or the shell variable syntax ($variable).

> if there is a prompt to confirm a selection, would you include that in instructions?

I'd say it depends on the prompt. Some programs of that kind make it very obvious what you're supposed to type or press. For example, if a program stops to ask you Do you want to proceed? [yes/NO], I think it's enough to document it as "Type yes". If you want to be safe, I'd mention Enter in the same sentence: "Type yes and confirm by pressing Enter."

> Any chance you have a public style guide for your documentation?

Our main style guide is the IBM Style Guide, which we've been using since long before the acquisition. It's pretty comprehensive. You can buy it as a book:

https://www.amazon.com/IBM-Style-Guide-Conventions-Writers-ebook/dp/B005Z09FOC

Then we also have a public supplementary style guide:

https://redhat-documentation.github.io/supplementary-style-guide/