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.
What information needs to be in a Technical Manual?
Subject:What information needs to be in a Technical Manual? From:"Nadine Underwood" <nadine -dot- underwood -at- orchard-systems -dot- co -dot- uk> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Wed, 7 Jul 2004 15:11:26 +0100
Hi
I have been tasked with creating a Technical Manual for a web hosted
application. All of my experience is in User Guides / System Admin
Guides etc. I have little experience, if any, in writing technical
documentation for technical users. Does anyone have any pointers on the
topics it should contain etc etc. Any guidance would be gratefully
received.
Thanks Nadine
------------------------------------------------------------------------
Nadine Underwood
Orchard Information Systems Limited, Newcastle Technopole,
Kings Manor, Newcastle upon Tyne, United Kingdom.
Registered in England, Number 1900078
Tel: +44 (0)191-203 2500 Fax: +44 (0)191-230 2515 http://www.orchard-systems.co.uk <http://www.orchard-systems.co.uk/>
ROBOHELP X5: Featuring Word 2003 support, Content Management, Multi-Author
support, PDF and XML support and much more!
TRY IT TODAY at http://www.macromedia.com/go/techwrl
COMPONENTONE DOC-TO-HELP 7 PROFESSIONAL: From a single set of Word documents, create online Help and printed documentation. New version offers yearly subscription service, Natural Search, Modular TOC Utility, Image Map Editor, Theme Designer, Context String Editor, plus more. http://www.componentone.com/doctohelp .
---
You are currently subscribed to techwr-l as:
archiver -at- techwr-l -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit http://www.raycomm.com/techwhirl/ for more resources and info.
