documenting software development processes

Subject: documenting software development processes
From: Viorel Lupu <pidgin -at- ua -dot- fm>
To: techwr-l -at- lists -dot- techwr-l -dot- com
Date: Tue, 10 Jan 2006 21:56:33 +0200

On my new job I got the task of designing and implementing an in-house documentation system that should describe (and prescribe) a specific software development workflow. As I understand it, I should produce a well structured set of documents (or standards) for software developers that would ensure that they document what they are doing in a specific way that requires miminum effort for other developers to maintain/update the code without reading every single line of existing code.

There is a wiki-based system in place which should do just that, but it is mostly empty and I have to work out how to make it work. The management has not decided yet on a specific approach, technology or standard that should be adopted. All they know it that they want reproduceable results and that something should be done about this. I am expected to come out with a workable solution. The entire project is Java-based, and javadoc is used to document the code but it does not do the job the way it is used now.

My question is what approaches, technologies, and standards are tipically used to document and standardize the software development process and what would be an ideal solution for a small software company? I am concerned mostly with the documenting side, without going too much into project management. Any help would be appreciated.

Thank you,
Documentation Manager


Домен .CO.UA БЕСПЛАТНО! Только на

Now Shipping -- WebWorks ePublisher Pro for Word! Easily create online
Help. And online anything else. Redesigned interface with a new
project-based workflow. Try it today!

Doc-To-Help 2005 now has RoboHelp Converter and HTML Source: Author content and configure Help in MS Word or any HTML editor. No proprietary editor! *August release.

You are currently subscribed to TECHWR-L as archive -at- infoinfocus -dot- com -dot-
To unsubscribe send a blank email to techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit

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

Send administrative questions to lisa -at- techwr-l -dot- com -dot- Visit for more resources and info.

Previous by Author: RE: Hourly vs. Salaried
Next by Author: Re: Friday Poll Idea (WAS: In love with a word)
Previous by Thread: Content Management Strategies for Word
Next by Thread: RE: documenting software development processes

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

Sponsored Ads