Documentation Phase in Software-Development Life Cycle

Subject: Documentation Phase in Software-Development Life Cycle
From: "Vlad Dracul" <vladvampiredracul -at- hotmail -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Wed, 24 Sep 2003 05:39:55 +0000


I work for a software start-up in which technical writers are expected to write in tandem with the development process, i.e., the software-development life cycle has no definite phase for documentation. Often, technical writers in this company have to write about features even before they are fully developed and stabilized. Consequently, technical writers are under tremendous pressure to ensure that features are accurately documented. A lot of rework occurs, and the quality of output is abysmal.

Those administering the development process have been requested to incorporate a documentation phase into the release cycle so that technical writers can work with a stable, tested product. Unfortunately, this request has been turned down, and the reason provided for this refusal is that the company follows a three-month release cycle and hence has inadequate time for a dedicated documentation phase.

I want to know the following:

* Is such a situation normal in a software company? Are there examples of other companies that work in such a fashion?

* How does one produce good documentation in on schedule in a setup such as this?

* Are there any documentation methodologies that lend themselves to this manner of working?

Suggestions and comments would be much appreciated.

Thank you.

Vlad

_________________________________________________________________
Add photos to your messages with MSN 8. Get 2 months FREE*. http://join.msn.com/?page=features/featuredemail


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

NEED TO PUBLISH YOUR FRAMEMAKER CONTENT ONLINE?
?Mustang? (code name) is a NEW online publishing tool for FrameMaker that
lets you easily single-source content to Web, intranets, and online Help.
The interface is designed for FrameMaker users, so there is little or no
learning curve and no macro language required! See a live demo that
will take your breath away: http://www.ehelp.com/techwr-l3

---
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
http://www.raycomm.com/techwhirl/ for more resources and info.



Follow-Ups:

Previous by Author: thoughts on multiple help systems for one application
Next by Author: RE: Documentation Phase in Software-Development Life Cycle
Previous by Thread: How to stay safe...
Next by Thread: Re: Documentation Phase in Software-Development Life Cycle


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


Sponsored Ads