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.
Re: "the following" or nothing -- what is IM's preference? (was:"Next" or "th...
Subject:Re: "the following" or nothing -- what is IM's preference? (was:"Next" or "th... From:HBacheler -at- aol -dot- com To:circe -at- lmi -dot- net, techwr-l -at- lists -dot- techwr-l -dot- com Date:Tue, 12 Dec 2006 17:20:26 EST
To all.
In my experience, the simpler the better.
I have 'always' put procedures in a table"
Step - Action - result (desired) -(In test procedures) Pass/fail)
The Table has a caption and heading row(s)..
I refer to the heading. by a cross reference.
This makes it easier to get to. And also, I can have an Appendix that is
made up of 'procedures.
Using this technique, it doesn't make any differences about above below. You
don't have to say on 'Previous page/, this page, next page, etc.
As different 'authors, editors, reviewers may have their own 'standards,
there is no mistake when referring to a Paragraph or a cross-reference, etc..Also,
when referring to Figures, Illustrations, Examples, etc, you avoid having to
worry about pages.
When you put a document on the web you are on the 'page', not matter how long
the 'page' is. the 'next page' may not be in the same file you put it in.
Especially if you have a long document and the webmaster, or web folks may
'reorient your 'page''.
As I have no personal knowledge of Information Mapping, Framemaker,
Pagemaker, or some of the more 'advanced' word processors, I tend to 'oversimplify'.
My experience has helped me take this approach. It allows a procedure to be
modified, amplified, and even be used as a TEST procedure if tests are
required. The table compuns can be modified to delete the "Pass'/''Fail' column.
WebWorks ePublisher Pro for Word features support for every major Help
format plus PDF, HTML and more. Flexible, precise, and efficient content
delivery. Try it today! http://www.webworks.com/techwr-l
Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include single source authoring, team authoring,
Web-based technology, and PDF output. http://www.DocToHelp.com/TechwrlList
---
You are currently subscribed to TECHWR-L as archive -at- infoinfocus -dot- com -dot-