Web Project Documentation softwares & steps

Posted on 2007-08-08
Last Modified: 2013-12-12

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.



Question by:devdept
    LVL 12

    Accepted Solution

    Its good to start with an RFP document, a request for proposal, here is a link to an outline of one:

    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:
    And here is a link to a working SRS document:
    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:

    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:

    Author Comment

    Admin close this issue
    LVL 1

    Expert Comment

    Forced accept.

    EE Admin

    Write Comment

    Please enter a first name

    Please enter a last name

    We will never share this with anyone.

    Featured Post

    Course: Create Mobile App Prototypes with Adobe XD

    This is a project-based course: we go through all the steps of creating a prototype from start to finish, using all the tools and features currently available in Adobe XD. You can complete the course in less than a day, plus all project files and fonts are included.

    Suggested Solutions

    Title # Comments Views Activity
    Lite dgn, dwg free viewer 1 61
    Visual xHarbour 1 47
    Convert 5 digit numbers to date 10 79
    How to add a m3u Playlist to IPTV on PLEX 7 406
    A high-level exploration of how our ever-increasing access to information has changed the way we do our jobs.
    International Data Corporation (IDC) prognosticates that before the current the year gets over disbursing on IT framework products to be sent in cloud environs will be $37.1B.
    The viewer will learn how to successfully create a multiboot device using the SARDU utility on Windows 7. Start the SARDU utility: Change the image directory to wherever you store your ISOs, this will prevent you from having 2 copies of an ISO wit…
    The viewer will learn how to successfully download and install the SARDU utility on Windows 8, without downloading adware.

    779 members asked questions and received personalized solutions in the past 7 days.

    Join the community of 500,000 technology professionals and ask your questions.

    Join & Ask a Question

    Need Help in Real-Time?

    Connect with top rated Experts

    16 Experts available now in Live!

    Get 1:1 Help Now