End-to-end software development cycle on a web-based application?

Question

We are looking for ways to further improve our software development process through proper documentation. However, being a document, these documentation/specification are only available whenever we open and read it.

For example, URS, SRS, ERD, DB Diagram, Class Diagram, Use Case, Test Scripts, User Manual and Training materials usually are separated documents.

Has anyone do this all within a single web-based system?

It starts with key-in all the requirements into the system and easily the URS can be generated. Whenever any changes to the requirements, it has to be entered into the system, but can easily generated.

The most important part is traceability, where we can see how requirements are implemented until the end. Sometimes, they are in URS, but missing along the way, since it is hard to compare / inspect it manually. Very often different person doing separate process, so things may omitted accidentally. For example, a function may exist in the system and test script, but not in the user manual.

I would imagine any changes at any part of the process that are not completely implemented, therefore actions can be taken.

Thanks!

Answer 1

Have you looked at Requisite Pro from Rational/IBM, our company went through a process looking for a requirements management suite, and that one was finally chosen. In the end we implemented using a Wiki for all documents, a master spreadsheet which numbered all features, and an Access DB which cross referenced the features to their bug counts and burn down, a pretty manual process but it worked suprisingly well with a project manager who had some coding experience.

Answer 2

We use Sphinx.

The documentation is in the repository with the code.

The documentation includes the code references via Sphinx .. addmodule commands.

Answer 3

We use XPlanner. It's mainly geared towards iterations in Xtreme Programming, but we also use it as a requirements planning tool. You can add freeform annotations to "stories" (=features in XP), which are just wiki pages (plus file attachments). You can also estimate times, create tasks etc.

Or you could just use a wiki. of which there are many. I would prefer something "free-form" like a wiki over something that provides/forces a specific workflow, since planning often does not rigidly follow a specific workflow anyway. (Whether that is good or bad is another matter...)