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:Kelley Walker <kelley -dot- walker -at- libtax -dot- com> To:tech2wr-l <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Wed, 29 Aug 2012 12:14:20 -0400
The typography class is probably overkill, but I'm guessing you will benefit from the document design class.
As for what to read, were I designing a course, I would start with the Robin Williams' work, The Non-Designer's Design and Type Book. This book has been invaluable to me, especially when I found myself doing book layout work. I'm assuming much of your documentation work will be read on a screen, in which case you may want to take a look at Jakob Nielsen's work on the topic (and the researchers to which he points) to see what can be culled and incorporated into your independent study. Nielsen recently wrote a piece talking about changing thinking and research on font faces and online reading: http://www.useit.com/alertbox/web-typography.html
When I searched for the exact title of Robin Williams' book, I also saw this book, which looks like it may be what you are looking for?
Document Design: A Guide for Technical Communicators by Miles Kimball and Ann Hawkins.
Hope that is helpful.
> -----Original Message-----
> From: techwr-l-bounces+kelley -dot- walker=libtax -dot- com -at- lists -dot- techwr-l -dot- com
> [mailto:techwr-l-bounces+kelley -dot- walker=libtax -dot- com -at- lists -dot- techwr-l -dot- com] On
> Behalf Of Becca
> Sent: Tuesday, August 28, 2012 8:35 PM
> To: tech2wr-l
> Subject: document design: I don't know what I don't know
> I am in a technical communication certificate program at our local community
> college. I'm trying to put together a proposal for an independent study class
> on document design from a writer's viewpoint. (My documents are
> serviceable, but not particularly inspired). The school has several courses that
> relate to what I want to learn: for example, there's a typography class and a
> document design class, but they're all part of the Graphics Design curriculum,
> and (from the few courses I've taken in that curriculum) very design-focused,
> not document-focused. I'm not a graphics designer, and not interested in the
> design of type faces, for example, but I know I need to know more about
> specing type faces beyond Arial and Times New Roman. the trouble is, I don't
> know what I don't know - I'm not sure where to begin asking the questions,
> much less finding answers.
> So - if you were designing a 3-credit course in designing technical
> documentation, what sorts of topics would you include?
> 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.
> You are currently subscribed to TECHWR-L as kelley -dot- walker -at- libtax -dot- com -dot-
> To unsubscribe send a blank email to
> techwr-l-leave -at- lists -dot- techwr-l -dot- com
> Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
>http://www.techwhirl.com/email-discussion-groups/ for more resources
> and info.
> Looking for articles on Technical Communications? Head over to our online
> magazine at http://techwhirl.com
> Looking for the archived Techwr-l email discussions? Search our public email
> archives @ http://techwr-l.com/archives
This electronic communication and any files transmitted with it, or attached to it, are confidential and are intended solely for the use of the individual or entity to whom it is addressed and may contain information that is confidential, legally privileged, protected by privacy laws, or otherwise restricted from disclosure to anyone else. If you are not the intended recipient or the person responsible for delivering the e-mail to the intended recipient, be advised that you have received this e-mail in error, and that any use, dissemination, forwarding, printing, or copying of this e-mail is strictly prohibited. If you received this e-mail in error, please return the e-mail to the sender, delete it from your computer and destroy any printed copy of it. Although our company attempts to sweep e-mail and attachments for viruses, it does not guarantee that either are virus-free and accepts no liability for any damage sustained as a result of 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.