開発者向けのアクセスアプリケーションの文書化[閉じた

Question

10年以上にわたってPower-Userによって完全に作成、開発、維持されたMSアクセスアプリケーションを文書化する必要があります。

これは興味深い状況です。なぜなら、彼らが望んでいるのはマニュアルであり、将来の開発者が以前のドメインの知識なしでやって来て、フロントエンドまたはバックエンドをタイムリーに変更できるからです。

この小さなプロジェクトについては、私の心にいくつかの質問があります。

• アプリケーションを作成する良い手動設計とは何ですか？ Microsoft Wordはそれを完全にカットしません。
• フォーム、レポート、テーブル、その他のアクセスオブジェクトなどを変更するために、開発者、開発者はどのようなことを知る必要がありますか？
• 他に逃したものはありますか？失敗はありますか？

Answer 1

私の経験では、アクセスとVB6ベースのプログラムは、主流の言語のプログラムよりも多くのコードレプリケーションと技術的債務に悩まされています。理由がわかりません。たぶん、それは「プロトタイプ」または「おもちゃ」データベースとしてのアクセスの性質かもしれません（ただし、正しく譲ると非常に強力になる可能性があります）。

ドキュメントに時間を費やす時間と技術的債務の削減に時間を費やすか、たとえばリグドウラー化、繰り返しコードの排除、長い機能の分割などを選択する必要がある場合、後者を選択します。メンテナビリティと読みやすさの改善は大きくなります。

Answer 2

VBA用のMZ-Toolsアドインを使用して、いくつかの自動コードドキュメントを生成することから始めることができます。同じアドインは、未使用の可変宣言をクリーニングしたり、ライン番号を生成したり、モジュール内で手順を繰り返したりするのに役立ちます。

フォームの文書化はより困難です。私の提案は、文書化されていないapplication.saveastextメソッドを介して取得された.txtファイルを使用して、スクリーンショットを保持することです。

Answer 3

これは長い間閉鎖されていることは知っていますが、2セントの追加を控えることはできません。
言及された事例では、生成する最も有用なドキュメントは機能的なドキュメント（理想的な世界で開発を開始する前に存在するはずだった）だと思います。
2番目はコード自体内にあり、VBAだけでなく、AccessおよびSQL Serverで設定できるフィールドの説明も含まれます。
3番目は、[または一連の）素敵なデータベース図です。それを手に入れると、残りはすべて、新しい開発者がお気に入りのツールを使用して生成できます。
ツールについて話すと、私は特に好きでお勧めします：

• MZツール：特にあなたの見ているものを呼ぶルーチンを簡単に見つけるために
• Smart Indent：適切にインデントコード。ひどくインデントされたコードを読み取ろうとすると、私は病気になります
• SQLSPEC ：（無料ではない）ほとんどのデータベースエンジンのデータベース自体のHTMLドキュメントを生成する

Answer 4

組み込みのデータベースドキュメンターを使用してみましたか？すべてのテーブル、インデックス、フォーム、コントロール、コントロールの各プロパティを印刷します。コード、使用されたSQL、およびほぼすべてのもの。これにより、巨大ですが、大規模な印刷物になります。ただし、その過程で数本の木を殺すことは確かに、ボスを感動させる素晴らしい方法です。