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: document design: I don't know what I don't know
Subject:RE: document design: I don't know what I don't know From:Debbie Hemstreet <D_Hemstreet -at- rambam -dot- health -dot- gov -dot- il> To:"'quills -at- airmail -dot- net'" <quills -at- airmail -dot- net>, Becca <becca -at- di -dot- org> Date:Wed, 29 Aug 2012 08:29:50 +0000
I would also include readability and useability studies, a unit on cognitive psychology, and a unit on general research.
By better understanding how different people learn, we begin to understand why what is obvious to one person is not obvious to another, hence the need for a certain amount of redundancy. Many people THINK they know how to research things, but they don't really do it, or their data is so limited that the results
Hope this contributes to the discussion.
Deborah
-----Original Message-----
From: techwr-l-bounces+d_hemstreet=rambam -dot- health -dot- gov -dot- il -at- lists -dot- techwr-l -dot- com [mailto:techwr-l-bounces+d_hemstreet=rambam -dot- health -dot- gov -dot- il -at- lists -dot- techwr-l -dot- com] On Behalf Of quills -at- airmail -dot- net
Sent: Wednesday, 29 August, 2012 5:19 AM
To: Becca
Cc: tech2wr-l
Subject: Re: document design: I don't know what I don't know
There are several things to look at in designing documents.
1. Analysis of the Audience,
2. Determination of the document's purpose.
3. Delivery method, and the advantages and disadvantages of each method.
4. Needs of the business unit.
5. Amount of information to present.
6. Amount and frequency of updates.
7. Method of updates.
8. Types of information to present.
************************************************************************************
This footnote confirms that this email message has been scanned by
PineApp Mail-SeCure for the presence of malicious code, vandals & computer viruses.
************************************************************************************
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Create and publish documentation through multiple channels with Doc-To-Help. Choose your authoring formats and get any output you may need.
Try Doc-To-Help, now with MS SharePoint integration, free for 30-days.
