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.
> I've read information about information plans and content specifications
> (mainly from Joann Hackos' book "Managing Your Documentation Projects"),
> but they seem to be geared towards brand new projects and not existing
> maintenance help systems. The thing is, if I can figure out revised
> template info for help HLDs and DDs, I could apply for a waiver to use my
> template. However, I'd like to do this right, so, if I were going to
> create a help HLD or DD (if these are even the words to be used?), which
> template fields should go into each one? Would you suggest one help design
> document instead?
>
> My company does not have a strong technical communication awareness, so I
> may be treading new ground. I'm pretty confused!! Any advice would be
> appreciated.
Since I do not know what exactly your company is looking for and what
it has in the way of HLDs and DDs, I suggest you work with your
friendly neighborhood engineer/developer to come up with a
plan/document.
At the least, I (personally) would document the tool used (RoboHelp?),
the template used, how the template is configured, the output
format(s) and thier properties, and the process followed to create
them.
I would argue that any form of documentation could be documented in
this manner, and would actually bring to light (to writers and
non-writers) just how technical some of our day to day work really is.
It would also give others more insight into what it means to be a
technical writer, at least from a toolset/workflow point of view.
Now Shipping -- WebWorks ePublisher Pro for Word! Easily create online
Help. And online anything else. Redesigned interface with a new
project-based workflow. Try it today! http://www.webworks.com/techwr-l
---
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- techwr-l -dot- com
Send administrative questions to lisa -at- techwr-l -dot- com -dot- Visit http://www.techwr-l.com/techwhirl/ for more resources and info.
