Re: System Architecture / Documentation

Subject: Re: System Architecture / Documentation
From: Megan Golding <mgolding -at- secureworks -dot- net>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: 17 Oct 2001 10:14:37 -0400

On Tue, 2001-10-16 at 16:09, Steven Brown wrote:
> Hi Megan,
> I think the most important thing to remember is that
> the needs of the organization should drive the
> documentation.

I agree wholeheartedly with you on assessing the needs of the
organization. One challenge we face right now is that the audience
hasn't / won't spell out (in any detail) what they need about these

I'm attached to a development group and the QA team is the largest
internal consumer of our documentation. This team has been asking for
"documentation" for over a year. When asked to define their
documentation requirements, the closest we get is, "We need you to
relate the system requirements to the code."

My challenge has been producing what the reader wants without them
explicitly telling me. Mind reading. :)

When developing documentation for internal users, I've often found that
these docs (more than any others) tend to go unread. So, to help get our
stuff read, I've decided to take a task-based approach to the internal
documents. We've taken our list of system requirements and I'll break it
down into sections such as, "How to perform task XYZ."



Megan Golding (mgolding -at- secureworks -dot- net)
SecureWorks, Inc.

Don't worry about the world coming to an end today.
It's already tomorrow in Australia.
-- Charles M. Schulz

Announcing new options for IPCC 01, October 24-27 in Santa Fe,
New Mexico: attend the entire event or select a single day.
For details and online registration, visit

Your monthly sponsorship message here reaches more than
5000 technical writers, providing 2,500,000+ monthly impressions.
Contact Eric (ejray -at- raycomm -dot- com) for details and availability.

You are currently subscribed to techwr-l as: archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit for more resources and info.

Re: System Architecture / Documentation: From: Steven Brown

Previous by Author: System Architecture / Documentation
Next by Author: Re: System Architecture / Documentation
Previous by Thread: Re: System Architecture / Documentation
Next by Thread: Re: System Architecture / Documentation

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

Sponsored Ads

Sponsored Ads