RE: Writing to your audience

Subject: RE: Writing to your audience
From: "Porrello, Leonard" <lporrello -at- illumina -dot- com>
To: 'Chantel Brathwaite' <brathwaitec -at- castupgrade -dot- com>, "techwr-l -at- lists -dot- techwr-l -dot- com" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Thu, 3 Mar 2011 15:23:33 +0000

A good point, and having different types of documentation isn't a compromise; it's a best practice. Ideally, you'll have three types of documentation: functional specs, administrator's guides, and end user guides/help. The functional spec is written by developers for developers, and in some development paradigms, such as Agile, is ideally contained in the code and comments; the functional spec has all of the nitty gritty and exhaustive details of exactly how an application works. The admin guide gives admins enough information to be able to understand the product and do their job; it might include things such as the algorithm you mentioned if understanding the algorithm is important for configuring and/or maintaining the product. End user docs give the end user just the info they need for an overall understanding of the product and how to complete specific tasks.

-----Original Message-----
From: techwr-l-bounces+lporrello=illumina -dot- com -at- lists -dot- techwr-l -dot- com [mailto:techwr-l-bounces+lporrello=illumina -dot- com -at- lists -dot- techwr-l -dot- com] On Behalf Of Chantel Brathwaite
Sent: Wednesday, March 02, 2011 2:51 PM
To: techwr-l -at- lists -dot- techwr-l -dot- com
Subject: Re: Writing to your audience

The compromise of course is to have different docs for different
audiences - so the internal user can be assured that the information
will show up in some piece of documentation (even if it is not the one
that they are reviewing at the moment) while the end user can have
document that addresses topics that will help them to complete their tasks.

--

Chantel Brathwaite

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

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.
http://www.doctohelp.com

---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit http://lists.techwr-l.com/mailman/options/techwr-l/archive%40web.techwr-l.com


To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
http://www.techwr-l.com/ for more resources and info.

Please move off-topic discussions to the Chat list, at:
http://lists.techwr-l.com/mailman/listinfo/techwr-l-chat


References:
RE: Writing to your audience: From: Dan Goldstein
Re: Writing to your audience: From: Phil
RE: Writing to your audience: From: Porrello, Leonard
RE: Writing to your audience: From: Matt Sean Gras
RE: Writing to your audience: From: McLauchlan, Kevin
RE: Writing to your audience: From: Dan Goldstein
RE: Writing to your audience: From: McLauchlan, Kevin
Re: Writing to your audience: From: Chantel Brathwaite

Previous by Author: RE: Writing to your audience
Next by Author: RE: Reasons to adopt FrameMaker
Previous by Thread: Re: Writing to your audience
Next by Thread: Re: Writing to your audience


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

Sponsored Ads


Sponsored Ads