適切な展開ドキュメントにはどのような情報が含まれますか？ [閉まっている]

Question

私は、展開ドキュメントの構成に関して、同僚とこれらの絶え間ない戦いをしています。

ドキュメントが必要であることに全員が同意します。特に、大規模なリリース、バグ修正、および機能強化を区別するために、どのレベルの詳細に取り組むべきかについて、誰もが共通点を見つけることができません。

あなたに最適な作品は何ですか？

Answer 1

ドキュメントの目的が、コードが繰り返し可能な方法でデプロイされることを保証することである場合、以下が最小推奨プラクティスです：

1. リリースの概要、変更点、バージョン、ソリューションファイルの場所などの概要。
2. 可能な依存関係を一覧表示
3. 詳細な展開手順
4. インストールに必要なデータベースの変更またはスクリプト
5. アプリケーションの構成方法の構成概要。
6. 実行可能なインストールを確認するために実行できる主要な機能テスト。
7. ロールバック手順-必要な場合。

Answer 2

ワンクリック展開を可能にするツールを構築する方が、展開に関する詳細なドキュメントよりもはるかに優れていることがわかりました。

Answer 3

ドキュメントの目的は何ですか？そこから始めて、その目標を達成するものを考えます。

私たちの目標は、グループのまったく新しいユーザーが、いくつかの異なるシステムに対して新しい展開または更新された展開を実行できるようにすることでした。私たちは、Windowsサービス、cronジョブ、データベースバックアップ、Webサイトの更新など、スープからナッツへの操作を行っています。

いずれの場合も、詳細レベルはシステムと、新しいチームメンバーが更新と新しい展開を実行するために必要なものに基づいていました。