January 19, 2012 at 10:00 am
Hi can some provide me some information of how to write documentation for existing Triggers. We have triggers code from 3rd party company. They do not have documentation, So now it's my responsibility to write some documentation. From where we need to start writing documentaion for triggers, can some one help me. Thank you.
January 19, 2012 at 11:53 am
Documentation is such a personal thing that changes depending on who you talk to or the documenting standards of the company in question.
I would advise a 2 tier approach. The first is to add comments to every trigger (and function and stored proc) that includes creation date, creator (if that information is available) and a basic description of what that object is meant to accomplish. Enforce this as a standard, making anyone who changes the object add the date, their name, and what changes they incorporated. In my environment, we have help ticket numbers that we also reference.
This first step is the most important. If you lose any other documentation, you won't lose the comments inside the objects themselves.
Then you need to develop a system, either a source control system or a word document or something, that lists out your triggers (and other objects) with any information you may think relevant to assist future developers in understanding the code.
Viewing 2 posts - 1 through 1 (of 1 total)
You must be logged in to reply to this topic. Login to reply