Open nelsonic opened 7 years ago
@nelsonic, here are my thoughts!
$
sign isn't mentioned in the O'Reilly conventions, but I personally think it makes clear to the reader, that this is what we expect to see on the terminal.constant width bold
for commands to be typed by the user!
When writing a "how-to" (e.g:
learn-xyz
) or general project documentation, should we have a list of writing conventions the wayO'Reilly
books (thebenchmark
for tech books) always have a "Conventions Used in This Book" section at the start of the book e.g: http://www.oreilly.com/openbook/debian/book/prf1_02.htmlTerminal Commands
When instructing people to run a certain
command
in theTerminal (Emulator)
, should we$
(dollar sign) in front of the command (or not) ?#discuss
constant width bold
for all "Commands or text to be typed by the user" ?For a complete list of the O'Reilly Typography and Font Conventions see: http://chimera.labs.oreilly.com/books/1230000000969/ch03.html PDF Snapshot: O'Reilly-Typography-and-Font-Conventions.pdf