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.
Re: Doc Design and Convention - to address Gene's take on this
Subject:Re: Doc Design and Convention - to address Gene's take on this From:"Gene Kim-Eng" <techwr -at- genek -dot- com> To:<techwr-l -at- lists -dot- techwr-l -dot- com> Date:Thu, 5 Nov 2009 12:36:57 -0800
Actually, I prefer to ask these questions about the product at development
kick-off, and use the answers to develop the document plan and defne the
document set. If I don't ask until I'm starting to think about specific
documents, I've missed several large steps in my preferred process.
If nobody can answer the questions at the earliest stages of development, I know
I'm not going to have a pleasant experience.
I'm glad to hear your thought process produces documents that work. You must
not have written any of the ones on my "shelf of shame." :)
Gene, when you think about what to put in a document, apparently you ask
yourself the same set of questions no matter what the document type, but you
formulate the answers differently for different types of documents. When I think
about what to put in a document, I ask myself a different set of questions for
each different type of document. The end result - a determination about what to
put in the document - is the same. Six of one, eight minus two of the other. Big
deal.
The main issue is to make the resulting documents serve the customers' needs.
This is an art, not a science, and there is plenty of room for variance in the
thinking about how things are done. The biggest question of all to ask about a
technical document is, does it work? Even though I apparently think in a
different manner, the employers for whom I have written answer that question
with the word "Yes."
Are you looking for one documentation tool that does it all? Author,
build, test, and publish your Help files with just one easy-to-use tool.
Try the latest Doc-To-Help 2009 v3 risk-free for 30-days at: http://www.doctohelp.com/
Help & Manual 5: The complete help authoring tool for individual
authors and teams. Professional power, intuitive interface. Write
once, publish to 8 formats. Multi-user authoring and version control! http://www.helpandmanual.com/
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-