best way to doc troubleshooting procedures?

Subject: best way to doc troubleshooting procedures?
From: "Rebecca Edmonson" <becky -at- ibrix -dot- com>
To: <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Fri, 23 Feb 2007 17:01:10 -0500

Currently each troubleshooting problem is a head, followed by paragraphed
text explaining the fix. At one point I tried putting them in a table, but
the fixes are so lengthy (some of them 3 paragraphs long) that the tabular
format it didn't seem helpful. The problem statements are wordy, and I don't
like the look of them when set as heads, but not sure how else to do it.
Hoping someone has figured out a creative fix for this.

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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

Now shipping: Help &amp; Manual 4 with RoboHelp(r) import! New editor,
full Unicode support. Create help files, web-based help and PDF in up
to 106 languages with Help &amp; Manual: http://www.helpandmanual.com

---
You are currently subscribed to TECHWR-L as archive -at- infoinfocus -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit http://lists.techwr-l.com/mailman/options/techwr-l/archive%40infoinfocus.com


To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
http://www.techwr-l.com/techwhirl/ for more resources and info.


Follow-Ups:

Previous by Author: RE: getting the comma into Frame index subentries
Next by Author: BIG Word file to PDF - with bookmarks?
Previous by Thread: Re: Subject line etiquette
Next by Thread: RE: best way to doc troubleshooting procedures?


What this post helpful? Share it with friends and colleagues:


Sponsored Ads