Web Development
Could any experienced Database administrator or Developer assist me by providing or direct me to a template which could assist me in database documentation e.g.
1) End user documentation,
2) Technical documentation,
3) Business case scenario etc.
My current method seems to have a number of flaws in it.
by donq
Using Microsoft Accessclick on the Tools option and select Analyze, Documentor. Access opens the Documentor window which allows you to document all or part (via Options selections) of the following:
Tables
Queries
Forms
Reports
Macros
Modules
Current Database (relationships & properties)
by indimulie
by bob sellman
Tech docs:
Use the Documenter (if you are using Access) as mentioned above. Also identify the requirements for installation (folders, paths, etc.), particularly so links to back end database(s) work. Be sure to document how security is handled and the userID and password used for full administrative access (in case of personnel changes, etc.). A CDR or CDRW copy of the back and front ends of the database is good. Include any hardware and software requirements, particularly the version of Access/VB or whatever that is used and identify what is used for development and modifying the application. Also document any administrative functions that should be performed (by DBA or developer).
Business docs:
What is the function of the application/database? Is it replacing a process? What are the benefits compared to what was done previously? Are there new capabilities (ex: analysis, other reports) which were not previously available? What makes it a better tool than the methods used previously?
End user:
Briefly describe what the db is supposed to help the user accomplish. Be sure to write a one to two page "quickie" instruction sheet that answers most questions, so users can avoid wading through endless pages of extensive detail. For more detailed parts of the docs, include indexes so topics can be found quickly.
It's important that you consider the expected skill level (technical/business/etc) of the target audience for each type of documentation. For example, if all users of the db are very skilled in Windows, you do not have to detail how to click and point and perform standard functions.
Nothing is perfect, so first try to determine the flaws in your current methods before making wholesale changes.
by indimulie
by indimulie
This discussion is closed to new replies.
Sort by Trending