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: Troubleshooting Documentation From:Carol Turner <rw -dot- cj -dot- turner -at- WORLDNET -dot- ATT -dot- NET> Date:Wed, 5 Aug 1998 08:33:13 -0500
Beth,
For an intranet I'd probably write it as an HTML Help system, with a very
complete index, a good TOC, and many related topics links within topics.
If your Help desk people have large monitors, your initial "overview"
topics might be 3 column tables leading to other topics (If you see this,
this is the problem, here's the solution -- the solution is a
link to a detailed topic.).
Carol
----------
> From: Marshall, Elizabeth <EMarshall -at- WCOM -dot- NET>
> To:
> Subject: Troubleshooting Documentation
> Date: Tuesday, August 04, 1998 12:19 PM
>
> Was wondering if anyone could recommend a resource for how to write
> troubleshooting documentation? I need to write some documentation to
> assist new help desk personnel with calls. It is going to published on
> our company's intranet.
>
> Elizabeth (Beth) Marshall
> Project Services, Systems Technical Writer
> 614-723-4451
>
