Re: 10 Things All Technical Writers Should Do

Subject: Re: 10 Things All Technical Writers Should Do
From: David Castro <thejavaguy -at- gmail -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Fri, 12 Nov 2004 06:18:06 -0500


So here's a more general question. I would bet that most people who've
been on the list for more than a few months have some "gems" that
they've filed away, printed, or bookmarked (in the archives on the web
site). What have *you* kept, and why?

I went looking through the stuff in my Techwr-L folder, and mostly
found replies to posts that I've made, but found a couple of general
posts that I decided to keep. Here's the oldest one, posted by Anthony
Markatos on February 17, 2000:

-----------------------------------------------------------------------------------------
Susan Harkus said:

[Principles in procedures writing:]

1. Give value in EVERY procedure step.
2. Eliminate steps that do not give value.
3. Minimise the number of steps.
4. Only provide procedures where they really are needed.

Tony Markatos adds:

5. To quote Ed Yourdon: "Procedure is like dance - it defies [written]
description". Therefore, use graphical techniques as much as possible;
ideally, only use written text to supplement graphics.

6. Present the bigger picture of the procedure first (using graphics) - then
filter down to the details (text). This is how the human mind processes
procedural information - especially the male mind. A big problem with
written-text-only procedural information is that, since it is so
detail-level, it works against the way the mind naturally wants to see
procedure - greatly increasing resistance to reading it.

Susan Harkus also said:

..research indicated that men resented procedures because they felt a sense
of disempowerment...

Tony Markatos responds:

I wish someone would have explained this to my basic military training drill
sargent!

-----------------------------------------------------------------------------------------

-David Castro
thejavaguy[at]gmail[dot]com
email[at]davidcastro[dot]com

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

ROBOHELP X5 - SEE THE ALL NEW ROBOHELP X5 IN ACTION!

RoboHelp X5 is a giant leap forward in Help authoring technology, featuring all new Word 2003 support, Content Management, Multi-Author support, PDF and XML support and much more! View an online demo: http://www.macromedia.com/go/techwrldemo

---
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.



Follow-Ups:

References:
10 Things All Technical Writers Should Do: From: Andrew Plato
Re: 10 Things All Technical Writers Should Do: From: Dick Margulis

Previous by Author: Re: ADMIN: New Poll Question
Next by Author: RE: Setting criteria for end users
Previous by Thread: Re: 10 Things All Technical Writers Should Do
Next by Thread: Re: 10 Things All Technical Writers Should Do


What this post helpful? Share it with friends and colleagues:


Sponsored Ads