application documentation

Posted on 2011-10-10
Last Modified: 2012-05-12
Hey - if you buy a 3rd party application - lets say an intranet based payroll app, runs on windows server, viewed in a browser, backend DB SQL Server. What sort of documentation about the app and its supporting infrastructure should you create/maintain (the customer who bought the app keep - or ask from the supplier)... and why? Or is it the supplier who should keep all the documentation as its their app? Or would auditors still expect you who host the app to have x y and z to be documented for the app?
Question by:pma111
    LVL 3

    Accepted Solution

    Good question, I am a big proponent of documentation you can't really go wrong with having it. You can't have to much!!

    This app will be hosted on your servers, will you be managing it, and backing it up?  Whom will be installing it you or the vendor?  

    My personal opinion is to have as much documentation as possible.  The Vendor should be able to provide you with full general documentation, and if they are the ones implementing it then those docs should be fully customized with your IP's, passwords, server names, etc.

    I am an IT consultant and I leave ALL my customers with full documentation!  I leave them basically with a script of what I did, not necessarily why, but enough that they could probably copy what I did and get the same results.

    I have a real dislike for vendors and consultants who leave empty spots in notes and docs on purpose so you will have to call them for information.

    Documentation is key, and has saved me time and time again.
    LVL 3

    Author Comment

    Us managing and backing up? Do you have a template of what kind of thing gets documented for an internally hosted app with ms infrastructure?
    LVL 3

    Expert Comment

    Unfortunately I don't have a general templates, mine are geared towards Exchange, Windows Infrastructure, and SharePoint.

    There are templates available online for specific servers and services, often times vendors have something that can work as well.

    Just to give you an idea of what you should include in your documentation:

    Any steps or specific configurations that are needed.
    Server Names
    Server Versions
    Backup Locations and procedures

    Basically you want to document the information you would need to recreate the environment in case of disaster or had to setup from scratch.

    There are some free templates at Microsoft -, also is a good source all though not free mostly.

    What I like to do, is to take screen shots and notes durring the process, so I am basically documenting all the steps throughout the install, and implementation so that there is a good record, and then I turn that into something presentable to a client or if it is something for my needs then I usually leave it the way it is.

    I hope that helps!!

    Featured Post

    Looking for New Ways to Advertise?

    Engage with tech pros in our community with native advertising, as a Vendor Expert, and more.

    Join & Write a Comment

    In today's information driven age, entrepreneurs have so many great tools and options at their disposal to help turn good ideas into a thriving business. With cloud-based online services, such as Amazon's Web Services (AWS) or Microsoft's Azure, bus…
    Many of us in IT utilize a combination of roaming profiles and folder redirection to ensure user information carries over from one workstation to another; in my environment, it was to enable virtualization without needing a separate desktop for each…
    This tutorial will walk an individual through the steps necessary to join and promote the first Windows Server 2012 domain controller into an Active Directory environment running on Windows Server 2008. Determine the location of the FSMO roles by lo…
    This tutorial will walk an individual through the process of transferring the five major, necessary Active Directory Roles, commonly referred to as the FSMO roles to another domain controller. Log onto the new domain controller with a user account t…

    729 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

    22 Experts available now in Live!

    Get 1:1 Help Now