Pau Lo
asked on
application documentation
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?
ASKER CERTIFIED SOLUTION
membership
This solution is only available to members.
To access this solution, you must be a member of Experts Exchange.
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.
IP's
Passwords
Shares
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 - http://office.microsoft.co
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!!
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.
IP's
Passwords
Shares
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 - http://office.microsoft.co
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!!
ASKER