It depends. How complex is the software? How complex does the user need to be? Etc.
For example, software needs installing and using. Should these be documented in the same manual? Is this software used by pHD geneticists in their search for a cancer cure? If so, do we need to document algorithms, formulae, approaches, etc? Where should that go? Does the software have a variety of complex engineering uses such that tutorials or lessons would be a significant benefit? Where do those go? Is this veteran software with known issues such that a troubleshooting section is available? Or, is this a very small and simple VBA application or game that doesn't do a heckuva lot? And so on and so forth ad infinitum. Cheers, Sean P.S. In general, I include screen captures in the printed docs when they clarify a set of instructions, to help visual learners. The screen captures must reflect what the software looks like, what the document is on about, and realistic settings that make sense. In general, I avoid putting screen captures in the online help because I assume the user already has the software open and doesn't need a picture of the dialog box they are already looking at and because graphics add size. -----Original Message----- From: [EMAIL PROTECTED] [mailto:[EMAIL PROTECTED] On Behalf Of Johnson, Joyce Sent: Monday, July 16, 2007 6:13 PM To: [email protected] Subject: [TCP] Software Manual Hi All - What should be included in a software manual? This may seem like a simple question, but a colleague of mine has a very different opinion than mine on exactly what the contents of a software manual should include, so I'm asking the experts. How do you feel about screen captures in a software manual? Are they essential or can you do without them? Do you think online help can replace a software manual? Thanks for your help! DISCLAIMER: Important Notice ************************************************* This e-mail may contain information that is confidential, privileged or otherwise protected from disclosure. If you are not an intended recipient of this e-mail, do not duplicate or redistribute it by any means. Please delete it and any attachments and notify the sender that you have received it in error. Unintended recipients are prohibited from taking action on the basis of information in this e-mail.E-mail messages may contain computer viruses or other defects, may not be accurately replicated on other systems, or may be intercepted, deleted or interfered with without the knowledge of the sender or the intended recipient. If you are not comfortable with the risks associated with e-mail messages, you may decide not to use e-mail to communicate with IPC. IPC reserves the right, to the extent and under circumstances permitted by applicable law, to retain, monitor and intercept e-mail messages to and from its systems. ______________________________________________ Author Help files and create printed documentation with Doc-To-Help. New release adds Team Authoring Support, enhanced Web-based help technology and PDF output. Learn more at www.doctohelp.com/tcp. Interactive 3D Documentation Parts catalogs, animated instructions, and more. www.i3deverywhere.com _______________________________________________ Technical Communication Professionals Post a message to the list: email [EMAIL PROTECTED] Subscribe, unsubscribe, archives, account options, list info: http://techcommpros.com/mailman/listinfo/tcp_techcommpros.com Subscribe (email): send a blank message to [EMAIL PROTECTED] Unsubscribe (email): send a blank message to [EMAIL PROTECTED] Need help? Contact [EMAIL PROTECTED] Get the TCP whole experience! http://www.techcommpros.com
