Kleines Unternehmen. Wir haben eine recht robuste Anwendung entwickelt, die auf AWS läuft und viele Kunden bedient. Unser Systemadministrator/leitender Entwickler hat das Unternehmen verlassen und Wissen mitgenommen, das wir nicht alle geteilt haben.
Unsere anderen Entwickler haben die Codierung problemlos gelernt. Als Projektmanager habe ich gelernt, wie man die Serverbereitstellungen im Allgemeinen mit Laravel Forge und AWS verwaltet, je nach Bedarf. Da ich mehrere Jahre auf allgemeiner Ebene in AWS gearbeitet habe, kenne ich dieGrundlagen.
Ich verfüge über ein umfassendes Verständnis der Architektur, verstehe jedoch nicht alle Beziehungen zwischen den Elementen vollständig.
Ich möchte die verwendeten Instanzen, IPs, Volumes, Sicherheitsgruppen, Schlüssel usw. und deren Beziehung zueinander dokumentieren. Wenn möglich visuell oder zumindest in Tabellenform.
Ich finde langsam heraus, wie ich alles finden kann.
Hat jemand Vorschläge, wie man eine leicht verständliche Dokumentation für ein System erstellen kann?
Ich arbeite in Excel, Powerpoint, Gliphy usw. daran und muss immer wieder von vorne anfangen und die Layouts überarbeiten, weil ich eine neue Beziehung feststelle, die ich vorher nicht verstanden hatte.
Ich bin für jeden Tipp dankbar.
Antwort1
Ich habe noch kein Tool gefunden, das automatisch gute und nützliche AWS-Diagramme erstellt. Ich verwende einige Tools, wenn ich eine Liste von Ressourcen möchte:
- AWS Tag Editor: in AWS integriert, stellt lediglich eine Liste bereit, die Sie exportieren können
- Cloudockit: habe es nicht benutzt, aber es sieht so aus, als könnte es nützlich sein
- CloudCraft.co: nützlich für Listen und Diagramme, aber nicht so gut bei Diagrammen wie ich gehofft hatte
- AWS-Retriever: bietet eine Liste von AWS-Ressourcen, scheint aber eine Beta-Software zu sein
Ich finde draw.io oder derenOfflineclientsehr effektiv zum Erstellen von AWS-Diagrammen.