回答:
これらすべてを詳細に文書化する必要がありますが、オペレーティングシステム、アプリケーションサーバー、Webサーバーなどの操作が標準である場合、IT運用担当者がその方法を知っていると想定できる場合があります。
インストール:正しく動作しているかどうかを確認する方法を含め、インストールと構成の方法に関するすべてを文書化します。
アーキテクチャ、特にさまざまなソリューションコンポーネント間の通信について教えてください(たとえば、ポートの範囲-RPCメカニズムは多くの場合、ポートの範囲を使用します-範囲とは何か、アプリケーションがポートを使い果たす可能性があるときを知る必要があります)。
パッチ適用:アプリケーションに固有のすべてを文書化します-パッチ適用前にシャットダウンする必要があるもの、およびパッチ適用後のフォローアップアクション(キャッシュ、インデックス、クリアまたは再構築する必要があるプロキシ)を文書化します。
保守:通常の動作と異常な動作がどのように見えるかを文書化します。監視する必要のあるキューやその他の事項、およびこれらの通常の範囲を文書化します。
データの管理方法、特にテーブルやファイルが無制限に大きくなる(ログファイルやトランザクション履歴など)方法を教えてください。これらはどのように削除する必要があり、古いエントリを削除するとどのような影響がありますか?(報告等について)。
標準的な「通常どおりの」ビジネス/インライフ管理アクションの実行方法を教えてください。これには、たとえば、ユーザーアカウントの追加や変更が含まれます。
必要となる可能性のあるその他の定期的な管理アクションについて教えてください(たとえば、どの証明書が使用され、期限が切れたときに何をするか)。
すべての変更について、それらをロールバックする方法を教えてください(すべての変更が成功するわけではありません)。そして、ロールバック計画をテストしたことを教えてください!
診断:ログファイルの形式と場所、および表示される可能性のあるすべてのアプリケーションエラーメッセージを文書化し、エラーメッセージの意味が間違っていること、および修正するために何を変更する必要があるかを示します。2つの異なるイベントに同じエラーメッセージを使用しないでください。
ダウンして起動する:方法、順序、特別な手順(たとえば、サーバーがシャットダウンする前に接続をドレインできるようにする)。
これを行う最善の方法は、アプリケーションをフェンスを越えて投げ、IT担当者に必要なものを検討させることであることに強く反対します。運用ドキュメント(および一般に、アプリケーションの管理機能)は、事前に検討する必要があります。
次の質問は、開発者が十分なドキュメントを提供しなかった場合(そうでない場合)はどうなりますか?
開発者が使用するあらゆる欠陥追跡システムを使用して、ITがソフトウェアに対して欠陥レポートを入力できるようにすることをお勧めします。このようにして、たとえば、特定のフォルダー内のファイルをパージする必要があること、および1週間だけを保持する必要があることを知らされなかった場合、「アプリケーションがログファイルでディスクをいっぱいにする」という欠陥を入力できます。 「そして、そのフォルダーをパージするための文書化された手法についてIT部門と協力することを提案します。
ドキュメントの要件のリストは次のとおりです(特定の順序ではありません)。
(上のドキュメント:)
このようなドキュメントは、優れたドキュメントの例です。
このようなドキュメントは失敗に満ちていると思います:
また、FreeBSDハンドブックは、ドキュメントとOpenBSDのアプローチの優れた例です。彼らは適切に文書化されていないものを追い出します。
編集:このリストは決して完全なものではなく、すぐに頭に浮かんだ基本的なものにすぎません。また、ドキュメントは読みやすくする必要があります。誰かが投げたようなものではありません。
@スポイケ(まだ回答にコメントすることはできません..)
ITの実装者(役割は企業の種類と規模によって異なります)は、次のことを達成するために一貫して作業する必要があります。
インストール/ターンオーバーの最小要件 -言い換えれば、ITは受動的であってはならず、開発者がインストール/ターンオーバー時に必要な情報を「知っている」ことを期待します。アプリの適切なドキュメントを構成するものについて、ITにかなりの混乱/意見の不一致があることがよくあります。開発者は要件を理解しており(私たちは願っています)、IT部門は何が(最低でも)何が必要かを見つけるために因果関係を築く必要があります。
インストール/ターンオーバー手順 -エンタープライズ設定では、これを変更管理またはガバナンスと呼ぶ場合がありますが、基本的にはITがDev PRIORのトップインストールに座って製品とそのニーズの概要を説明する標準的なレビューサイクルです。
アプリのインストールは、演劇作品のデビューと同じです。幕が上がる前に、ディレクター(リード開発者)はステージ制作チーム(IT実装者)と繰り返し会って、オープニングナイト(パブリックインストール)のすべてが「まあまあ」であることを確認します。
Devペルソナを変更することはできませんが(なぜ変更したいのですか?)、すべてのユーザーが驚くほど高速に実行される素晴らしいアプリという共有の目標を示すことができます。コンセンサスITドキュメントの要件は、それを確実にするために必要なものの1つにすぎません。