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.
Template for equipment operator/maintenance manual
Subject:Template for equipment operator/maintenance manual From:T K <tvk_tw -at- yahoo -dot- ie> To:techwr-l -at- lists -dot- techwr-l -dot- com, techcomm -at- user -dot- itconsult -dot- co -dot- uk Date:Wed, 25 Jul 2007 17:10:10 +0100 (BST)
Hi,
I am going tobe writing operating / maintenance manuals for mechanical equipment to be used in a manufacturing engineering plant. The manuals are to accompany equipment being built in-house, so the overall machine will be from in-house but it will usually contain a number of purchased components too.
The company has an existing template but it is not very user friendly or clear so I feel the first step should be to get a template created before working on any of the content. I was just wondering if anyone could point me towards a source of information on how to design a new template or where I could find sample templates for manuals of this nature. Even good sample manuals would be useful to me to see what has been incorporated before.
Thanks,
Tom.
Send instant messages to your online friends http://uk.messenger.yahoo.com
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include support for Windows Vista & 2007
Microsoft Office, team authoring, plus more. http://www.DocToHelp.com/TechwrlList
True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity! http://www.helpandmanual.com
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-