ページから再利用可能な意味へ。
読みやすい技術文書を保ちながら、重要な概念に安定したアイデンティティ、参照、版、セマンティックレビューを与えます。
Topoloomを選ぶ理由
Serviceが変わったとき、 レビューすべきものを把握する。
読みやすい文書とダイアグラムはそのまま書き続けます。再利用やレビューが必要な事実には共有オブジェクトを使います。リポジトリと監視は、それぞれが持つ証拠の権威であり続けます。
現在のワークフローの問いTopoloomの場合
01
所有者はどこで繰り返されているか？
→安定した参照を検査する02
どの矢印が意味を持つか？
→型付き関係を宣言する03
レビュアーは何を見られるか？
→セマンティック変更を比較する04
規則はいつ確認されるか？
→公開を統制する05
外部の証拠はどう表示されるか？
→プロバイダーコンテキストを帰属付きで扱う06
エクスポート後に何が残るか？
→範囲を定めたパッケージを検査する変更をひとつ選ぶ · 二つのワークフローを比較する
実務上の違い
Serviceの変更をひとつ使う。 生じる作業を比較する。
現在のワークフローとTopoloomで、所有者または依存関係の変更を試します。各アプローチに必要な更新、レビュー手順、エクスポート作業を数えます。
| 現在のワークフローの問い | Topoloomの場合 | 検査すること |
|---|---|---|
| この所有者は今どこに記録されているか？ | ひとつのServiceオブジェクトを参照する | 所有者を更新すると、新しいオブジェクトバージョンが作られます。Used inには、ライブドラフトではなく、閲覧を許可された不変の成果物バージョン内の参照が出ます。 |
| どのダイアグラムリンクが意味を持つか？ | 重要な関係を宣言する | 型付きエッジは、ソース、ターゲット、来歴、ライフサイクル、版のコンテキストを保持します。視覚表現のみのコネクターは別のものとして扱われます。 |
| レビュアーは何を推測する必要があるか？ | セマンティック変更を検査する | テキストやダイアグラムの編集と併せて、所有者、依存関係、SLO、Decision、ライフサイクルの変更を比較します。 |
| 公開規則はいつ適用されるか？ | 組み込みのService Overview Contractを使う | 未完成の下書きは編集を続けられます。検証とレビューは、統制された公開時に適用されます。 |
| 外部の証拠はどう表示されるか？ | プロバイダーコンテキストを帰属付きで保つ | 対応プロバイダーを設定すると、その所見は人がオーサリング変更を受け入れるまで別のまま保たれます。 |
| エクスポート後にチームは何を検査できるか？ | 範囲を定めたパッケージを開く | 読める成果物、安定したID、版、関係、来歴、レビュー、マッピング、省略のレポートを確認します。 |
共有オブジェクトを検査する
所有者は Service に紐づく。
文書やダイアグラムから同じ Service を参照します。詳細と不変のオブジェクトバージョンによって、その共有アイデンティティの履歴を検査できます。
Used in は、閲覧を許可された不変の成果物バージョンに記録された参照を示します。すべてのライブドラフトを数えるものではありません。
セマンティックレビュー
意味がどう変わったかを確認する。
ダイアグラムの不変バージョンを比較し、再利用可能なオブジェクト参照の変更を確認します。ここでは Version 1 Baseline と Version 2 Current を比較しています。
エンジニアリングスタックに適合
各システムを補完する。 どの権威も混同しない。
Topoloomは共同オーサリングと、人向けのDocument Graphを担います。リポジトリ、サービスカタログ、CMDB、テレメトリ、コンテキストプロバイダーは、それぞれに適した証拠と運用上の真実を担い続けます。
形状から宣言済みの関係へ。
それで十分な場合は視覚表現のみのコネクターを残し、意味を統制すべきエッジだけを昇格させます。
意思決定を実装コンテキストにつなぐ。
オーサリングされたナレッジを実行時やコードの真実と見なすことなく、ソースの場所とDecisionを参照します。
証拠を宣言の隣に置く。
対応プロバイダーを設定すると、Topoloomは公開Contractを通じて接続し、その識別子を不透明なハンドルとして保持します。プロバイダーが報告した差分は、人がレビューできるコンテキストとして表示されます。利用できる内容はプロバイダーとデプロイメントにより異なります。
評価用スコアカード
ページ数ではなく、 ループを測る。
現在のワークフローとTopoloomで、同じServiceの変更を比較します。設定、二回目の更新、レビュー、エクスポートに要する手間を含めます。
- 01変更レビュー時間前後の所要時間
所有者、依存関係、SLO、Decisionの変更を理解するまでに、レビュアーはどれだけ時間を要するか？
- 02繰り返す編集変更ごとの更新数
同じServiceが変わったとき、手作業で更新が必要な場所はいくつあるか？
- 03所有カバレッジ各ワークフローで見つかった不足
宣言済みの所有者とレビュー可能な来歴を持つServiceはどれか？
- 04Runbook / SLOカバレッジ見つかった、または欠けた関係
どのServiceが、運用と測定に使うナレッジにつながっているか？
- 05モデルの保守設定と後続作業の手間
二回目の変更まで、参照の作成とモデルの保守にチームはどれだけ時間を使うか？
- 06エクスポート範囲エクスポートに含まれるもの
チームは製品の外で、含まれるレコードと明示された省略を検査できるか？
違いを評価する
コピーされた事実をひとつ持ち込む。 共有オブジェクトが手戻りを減らすかを試す。
現在のワークフローと、所有者または依存関係の変更を比較します。各アプローチが役立つ場所と、作業を増やす場所を記録してください。