タグ付けされた質問 「documentation」

私たちの環境に適したドキュメント（AsciiDoc形式）があり、最近、他の人がセットアップ全体を30分未満で最初から再作成できるようになりました。 ただし、最初のセットアップ後、システムに小さな変更が加えられたことが簡単に発生することに気付きました（たとえば、inetdが無効になり、IMAPサーバーがManageSieve接続の追加ポートでリッスンし、exim構成に新しいルーターが追加されます）。 （もしあれば）すぐにドキュメントに記載されることはありません。 これを実装する1つの方法は、配置するかもしれ-私の考えでは、その中にコンフィギュレーションファイルおよびコメントの外にドキュメントを生成する（？部分的に）することで、この問題を回避するためだった/etcと/usr/local/etcいくつかのソースコード管理システムに（と言う- gitの）、その後、Aを実行しますコミットごとにドキュメントを再生成するスクリプト。しかし、それがやりすぎであるか、正しく理解するのが難しすぎるかはわかりません（結局のところ、ドキュメントのソースファイルの完全なコピーではなく、diffだけが必要です）。 他の人々はサーバーのドキュメントが古くなるのをどのように避けますか？それらを自動的に同期を保つための良い方法はありますか、それともシステムを変更すると同時にドキュメントを更新する規律がありますか？

8 documentation 

ロックされています。質問はトピックから外れていますが、歴史的に重要であるため、この質問とその回答はロックされています。現在、新しい回答や相互作用を受け入れていません。 タイトルは本当にすべてを語っています。 最終的には、開発とITがこの種の事柄について頭を悩ませることになるかもしれません。1つまたは複数のサーバーで実行されているソリューションのインストール、パッチ適用、保守、開始、停止、および診断が予想される場合、どのレベルのドキュメントが予想されますか？

8 documentation