|
|
|
|
|
Stored Procedures Stored procedure documentation shall consist of a high level explanation of the stored procedure. Due to the inherent complexity of most stored procedures, there shall also be a detailed explanation of the structures and control of flow performed within the stored procedure. The stored procedure shall have a notation of whether the procedure is run on demand or is a scheduled task. If it is a scheduled task it shall also state whether it is one time or recurring and the frequency of the recurring execution. There shall be a notation as to whether this is an administrative or application stored procedure. If the stored procedure was created for an application, the name of application and application component that required the stored procedure shall be noted. This is done to help in maintenance. If the application or component that needed the stored procedure is eliminated, the stored procedure can be removed from the database. Views View documentation shall consist of an explanation of the purpose of the view. It will also contain a list of the tables involved in the view. A notation as to whether the view is for read only purposes or allows updating shall also be made. The application and application component that required the view shall be noted as well. This is done to help in maintenance. If the application or component that needed a view is eliminated, the view can be removed from the database. User Defined Datatypes User defined datatype documentation shall consist of the underlying datatype used, the tables and columns used in, and an explanation of why the user defined datatype was created. This is done to help in maintenance. If the user defined datatype is no longer needed because of database redesign, the datatype can be removed. Remote Procedure Calls Remote procedure call documentation shall consist of the remote servers involved in the RPC and the purpose of the RPC. This is done to help in maintenance. If the moving or renaming of a server is planned, this will help avoid application problems where the referenced server can no longer be found. Tasks Task documentation shall consist of an explanation of what the task does, why it was implemented, and the frequency of the task. Alerts Alert documentation shall consist of what type or level of alert it is, any actions taken where the condition that caused the alert happens, who is notified by the alert, and why the alert was implemented. |
All content on this site, except where noted, represents an original work of Michael R. Hotek and is protected by applicable copyright laws. The SQL Server FAQ is the sole work of Neil Pike. No page, portion of a page, or download may be used for commercial purposes in whole or in part without the express, written permission of the applicable author.