TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
Subject:RE: Text format of user inputs (paper manuals) From:"Beth Kane" <BethKane -at- TCISolutions -dot- com> To:<TECHWR-L -at- LISTS -dot- RAYCOMM -dot- COM> Date:Thu, 16 Sep 1999 09:14:52 -0700
I agree that using quote marks is bad, because _someone_ is going to end up
typing 'em in the command line. One thing we've done in many manuals, and it
was very clear to users, was put commands on a separate line and indented a
little bit, as in:
To get started building your own dog kennel, type:
homecrate <Enter>
The Homemade Crate window appears.
(Any keys that need to be pressed are shown within angle brackets.)
~Beth
bethkane -at- tcisolutions -dot- com
-----Original Message-----
In a software training manual, how should I format the text that users have
to enter? At the moment, we have:
Type "Report on Angle Model" in the <bold>Title</bold> box.
