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.
Subject:Re: New Writer Seeks Advice From:HBacheler -at- aol -dot- com To:"TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Tue, 4 Jan 2005 23:03:15 EST
To all
I think at this time it should be understood that the question is about
documenting the Application.as it applies to the user. NOT as it applies to the
developer of the Software.
I have been on both sides of the fence (documenting software and documenting
applications) over the years, including hardware documentation, and have
found that often the 'standards' are murky to say the least.
There are 'standards' that apply to the documenting of SOFTWARE. These are
contained in the Requirements specification, the architecture, system design,
etc., that should be used by the architects of the system.
The 'Standards' for the documenting of Applications are as diverse as the
applications being described. And are often at the whim of the technical
writer, the reviewers, and the manager running the project.
In the documentation of the SOFTWARE (the Application) the suggestions of
other posters of talking with the developers, the designers, and others who
have 'extensive' knowledge of what the 'purpose' of the application is the best
way to begin the documentation effort.
Take a look at the documentation that comes with the 'tools' you use and you
will find great, good, and mediocre examples of 'software' documentation.
My technical writing experience has taught me that there is no 'right' way
that fits all eventualities and needs.
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.
