小さな会社です。当社では、AWS 上で実行され、多くのクライアントにサービスを提供する、かなり堅牢なアプリケーションを構築しています。当社のシステム管理者/主任開発者が退職し、全員が共有していなかった知識を持ち去ってしまいました。
他の開発者はコーディングを簡単に習得しました。プロジェクトマネージャーとして、私は必要に応じてLaravel ForgeとAWSの両方を使用してサーバーの展開を管理する方法を学びました。AWSで一般的なレベルで何年も働いてきたので、基礎。
アーキテクチャについては高いレベルで理解していますが、要素間の関係をすべて完全に理解しているわけではありません。
使用されているインスタンス、IP、ボリューム、セキュリティ グループ、キーなどとその関連性を文書化したいと考えています。可能であれば視覚的に、少なくとも表形式で。
すべてを見つける方法をゆっくりと理解しつつあります。
システムのわかりやすいドキュメントを作成するための良い方法について、何か提案はありますか?
私はこれを Excel や Powerpoint、Gliphy などで試していますが、以前は理解していなかった新しい関係があることに気づき、最初からやり直してレイアウトを作り直すことになります。
何かヒントがあればいただければ幸いです。
答え1
優れた便利な AWS ダイアグラムを自動的に作成するツールはまだ見つかっていません。リソースのリストが必要な場合に使用するツールがいくつかあります。
- AWS タグエディター: AWSに組み込まれており、エクスポートできるリストを提供するだけです
- クラウドイット: 使ったことはないけど、便利そうだ
- クラウドクラフト: リストや図には便利ですが、図に関しては期待したほど優れていませんでした
- AWS レトリーバー: AWS リソースのリストを提供しますが、ベータ版ソフトウェアのようです
私はdraw.ioやそのオフラインクライアントAWS ダイアグラムの作成に非常に効果的です。