• Status: Solved
  • Priority: Medium
  • Security: Public
  • Views: 1904
  • Last Modified:

Web Project Documentation softwares & steps

hi,

I am working on a new web application project. For this i want to know the steps for documentation.

If anybody can quote some softwares or procedures which maintains universal standards will be a gr8 help to start.

regards,

M AS

0
devdept
Asked:
devdept
1 Solution
 
lunadlCommented:
Its good to start with an RFP document, a request for proposal, here is a link to an outline of one:
http://www.gotoems.com/rfp_outline.htm

And it is also good to maintain a growing document, SRS, that outlines then specifies the requirements of the project, here is a link to an SRS outline, this example explains it really well:
http://www.stellman-greene.com/images/stories/Library/SRS%20Outline.pdf
And here is a link to a working SRS document:
http://www.cse.iitk.ac.in/JaloteSEbook/CaseStudies/CaseStudy2/SRS.pdf
The above work well for the planning and continued evaluation of a project and the project state.

It is also important to use some kind of version control during the development of a project, SubVersion is a great tool for this, it runs on Linux and is capable of running on windows with little work. It can be used to keep documentation information on a per file basis during the development of the software:
http://subversion.tigris.org/

This will take care of documentation for managers, planners, and current developers; next you need to document information for future developers, the end-user, and maintainers..

These can be done in tutorial format, that include adding new sections of the software, bug tracking, recovery, and content management. As well as tutorial information/documentation on how to use the software. This is instructional information that will be facilitated by the previously stated documentation.

Also, NASA provides an outline for an all encompassing documentation standard, it is worth a look:
http://satc.gsfc.nasa.gov/assure/docstd.html
0
 
devdeptAuthor Commented:
Dear
Admin close this issue
0
 
Computer101Commented:
Forced accept.

Computer101
EE Admin
0
Question has a verified solution.

Are you are experiencing a similar issue? Get a personalized answer when you ask a related question.

Have a better answer? Share it in a comment.

Join & Write a Comment

Featured Post

Cloud Class® Course: SQL Server Core 2016

This course will introduce you to SQL Server Core 2016, as well as teach you about SSMS, data tools, installation, server configuration, using Management Studio, and writing and executing queries.

Tackle projects and never again get stuck behind a technical roadblock.
Join Now