8

私は、MSSQL データベース (オブジェクト、テーブル、テーブル データ) の MediaWiki ドキュメントを生成するアプリケーションを作成中です。

私の質問は、どのドキュメント形式を好むか、または作成する必要があるかです。従うべきアイデアが多すぎるので、あなたの答えが私の優先順位を設定する必要があります;)

(SO に関する他のドキュメント関連の質問があることは知っていますが、それらは主にドキュメントの生成方法を扱っており (方法は知っています)、特定のドキュメントの種類やプラットフォームについては尋ねていません)

編集：コメントありがとうございます。外部キーを解析するので、実際にはすでにテーブル関係があります。ただし、完全な相互参照は少しトリッキーかもしれません;)

ただし、この質問は、Word、PDF、ODF など、ドキュメントの種類を尋ねることを目的としていました。あなたの専門的な要件や好みは何ですか?

更新: 生成されたドキュメントの概要

4

2 に答える 2

7

MediaWiki マークアップに基づく HTML であるドキュメント形式を既に決定しているようですね。

また、データベース ドキュメントへの有用な追加であるエンティティ関係図を生成する必要があります (ただし、ERD も全体像を示しているわけではありません)。

ドキュメントの編成、つまり各ページにどのような見出しとコンテンツを含めるべきかということですか?

以下にいくつかの提案を示します。

  1. テーブル構造

    • 列名、データ型、制約
    • 各列の意味と使い方
    • トリガーとアプリケーション コードの余分な論理制約
    • インデックスの定義

  2. 他のテーブルとの関係

    • これに依存するテーブル
    • このテーブルが依存するテーブル
    • データベースの制約によって強制されない、特別な関係または暗黙の関係に関する注意事項

  3. テーブルの使い方

    • ストアド プロシージャでの使用
    • アプリケーションコードでの使用
    • ビューでの使用
    • 誰が読み取りおよび/または書き込みアクセス権を持っているか; 各ユーザーまたはロールの SQL 特権

StackOverflow には、これに非常に近い他の質問があります。

于 2009-01-12T00:05:36.953 に答える
0

商用ベンダーがこれに関して何をしているかを調べたいと思うかもしれません. ビルが言ったように、ER図は確かに必要です。注目すべき商用製品には、Embarcadero ER/Studio、Red-Gate SQL Doc、Power Designerなどがあります。

于 2009-01-12T13:19:49.440 に答える