Écrire une description de table appropriée

Je suis, pour la première fois, en train d'écrire des descriptions pour mes tables SQL Server (à partir du champ Description dans la window Properties ), et j'ai commencé à réfléchir à ce qu'il faut écrire exactement dans un tel champ.

Par exemple, certaines tables sont explicites en fonction de leurs titres … comme une table appelée Albums dans un "Système de Musique". Quelle description écririez-vous réellement dans un tel cas?

Et quelles autres informations incluez-vous normalement dans la description? Mentionnez-vous les relations à la table?

Existe-t-il une manière standard et formelle d'écrire des descriptions pour les arrays?

Je crois qu'un bon object de nommage et de design plus éventuellement un outil qui permettrait de visualiser votre structure de database ( par exemple SQL Doc ) est beaucoup mieux que d'append une description détaillée à chaque object.

Plus vous voulez couvrir dans la description, plus il est probable qu'il sera désynchronisé par rapport à la structure réelle de la database. Par exemple, si vous souhaitez documenter la relation, chaque fois que vous la modifiez, vous devez vous callbacker de mettre à jour les descriptions (sur tous les objects concernés). Il s'agit essentiellement d'informations redondantes car elles sont déjà enregistrées dans le schéma. Nous ne voulons pas de redondance, n'est-ce pas la database?

3 déclarations simples devraient faire pour une description de table: une décrivant ce que la table contient, un décrivant l'état initial des données dans la table (vide ou prérempli), et un décrivant comment datatables entrent / sortent de la table.

J'inclurais également la cardinalité / la relation de la table par rapport à d'autres tables importantes. Cela peut sembler évident, mais souvent ce n'est pas le cas. Par exemple pour tblAddresses vous pourriez avoir la description:

" Cette table est une table parent pour les lignes de détail d'adresse (tblAddressLines) et est référencée par (et PAS un enfant de) la table Employees (tblEmployees). "

Je mettrais le nom des emplois / programmes / rapports qui utilisent cette table dans la description. Il est difficile d'avoir besoin d'une mise à jour constante et répond à la question: pourquoi cette table existe-t-elle? (c'est-à-dire Qui est cette donnée?)

Si vous utilisez le contrôle de code source, je ne peux pas penser à tout commentaire à mettre ici qui ne serait pas mieux utilisé comme commentaire SCC. Je pense que c'est superflu, et je ne l'utiliserais pas à less que votre organisation ait une norme pour cela.