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: Documenting the user interface--unnecessary features?
Subject:RE: Documenting the user interface--unnecessary features? From:"Gordon McLean" <Gordon -dot- McLean -at- GrahamTechnology -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Thu, 11 Jan 2007 15:44:47 -0000
Well I guess in some instances it can be as much a culture decision as
anything. If you have a genuine need to document every single UI button,
widget and doo-dah, then do so.
However anywhere I've worked, I've been able to question WHY something was
in the product, so maybe that's a discussion to have with your manager.
Perhaps certain UI items have been left in rather then being removed because
it was easier for development? Who knows.
But, if your manager says it should be doc'd, then doc'd it'll be (I'd still
argue my case with him though.. but that's just me).
Gordon
-----Original Message-----
From:
techwr-l-bounces+gordon -dot- mclean=grahamtechnology -dot- com -at- lists -dot- techwr-l -dot- com
[mailto:techwr-l-bounces+gordon -dot- mclean=grahamtechnology -dot- com -at- lists -dot- techwr
-l.com]On Behalf Of Kay Honaker
Sent: 11 January 2007 15:34
To: Peter Sturgeon; TECHWR-L
Subject: RE: Documenting the user interface--unnecessary features?
Quote from my manager: "If it's in the product, then it should be in doc. Is
how I generally see it."
-----Original Message-----
From: techwr-l-bounces+khonaker=accela -dot- com -at- lists -dot- techwr-l -dot- com
[mailto:techwr-l-bounces+khonaker=accela -dot- com -at- lists -dot- techwr-l -dot- com]On
Behalf Of Peter Sturgeon
Sent: Thursday, January 11, 2007 8:21 AM
To: TECHWR-L
Subject: RE: Documenting the user interface--unnecessary features?
--- Kay Honaker <khonaker -at- accela -dot- com> wrote:
> The features in the software are all there to serve someone,
> otherwise, why are they there?
A feature may serve Someone without serving Everyone.
A feature may serve noone, but the developer thought it was cool to
include.
A feature may have served people in the past, but is no longer
required.
A feature may appear because of a desire for foolish consistency.
I'm sure there are other reasons for features to exist.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
WebWorks ePublisher Pro for Word features support for every major Help
format plus PDF, HTML and more. Flexible, precise, and efficient content
delivery. Try it today! http://www.webworks.com/techwr-l
Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include single source authoring, team
authoring,
Web-based technology, and PDF output. http://www.DocToHelp.com/TechwrlList
---
You are currently subscribed to TECHWR-L as khonaker -at- accela -dot- com -dot-
WebWorks ePublisher Pro for Word features support for every major Help
format plus PDF, HTML and more. Flexible, precise, and efficient content
delivery. Try it today! http://www.webworks.com/techwr-l
Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include single source authoring, team
authoring,
Web-based technology, and PDF output. http://www.DocToHelp.com/TechwrlList
---
You are currently subscribed to TECHWR-L as
Gordon -dot- McLean -at- grahamtechnology -dot- com -dot-
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/techwhirl/ for more resources and info.
________________________________________________________________________
This email (and any attachments) is private and confidential, and is intended solely for the
addressee. If you have received this communication in error please remove it and inform us via
telephone or email. Although we take all possible steps to ensure mail and attachments
are free from malicious content, malware and viruses, we cannot accept any responsibility
whatsoever for any changes to content outwith our administrative bounds. The views represented
within this mail are solely the view of the author and do not reflect the views of the organisation
as a whole.
________________________________________________________________________
Graham Technology plc http://www.grahamtechnology.com
________________________________________________________________________
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
WebWorks ePublisher Pro for Word features support for every major Help
format plus PDF, HTML and more. Flexible, precise, and efficient content
delivery. Try it today! http://www.webworks.com/techwr-l
Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include single source authoring, team authoring,
Web-based technology, and PDF output. http://www.DocToHelp.com/TechwrlList
---
You are currently subscribed to TECHWR-L as archive -at- infoinfocus -dot- com -dot-
