本文へ移動
ひとつの安定したアイデンティティ 人によるオーサリングが基本 ポータビリティを前提に設計
Topoloom by Relia1

用語集 · 日本語

用語を理解する。 挙動を確認する。

まず平易な定義を読み、次にTopoloomでの使われ方と、自分の環境で確認すべきことを見ます。

定義は現在の製品の言葉を説明し、評価ノートは各概念をデプロイメントでどう確かめられるかを示します。

製品の定義

Topoloom は各概念をどう使うか。

各項目は、平易な定義、製品での適用、そしてデプロイメントごとに確かめるべき挙動を分けて説明します。

Workspace

定義人とナレッジのための、独自のアクセス境界を持つ独立した領域です。各文書、ダイアグラム、オブジェクト、メンバーシップはひとつの Workspace に属し、すべてのリクエストでその Workspace の有効なメンバーシップを確認します。

Topoloom での使い方Topoloom は、Trust ページで説明するテナント分離の単位として Workspace を使います。取得、投影、エクスポート、イベント配信、プロバイダーアクセスの前にスコープが強制されます。拒否は、その項目が存在するかどうかを何も明かしません。

お使いの環境で確かめることどの検索、参照、オートコンプリート、件数がメンバーシップでスコープされるか、拒否されたリクエストが何を返すかを確認してください。次に、複数の Workspace にロールを持つ人が、別の Workspace の識別子やタイトルを見ることがあり得るかを確かめます。

Library

定義ある人が Workspace で読むことのできる文書とダイアグラムの一覧です。各項目の種類と状態を表示し、現在のアクセス権で結果を絞り込みます。

Topoloom での使い方Topoloom はプラットフォームのキャプチャ S1 で Library を示しています。そこでは文書とダイアグラムが、Collection のナビゲーションと非公開ドラフトのビューの横でひとつの一覧を共有しています。

お使いの環境で確かめることLibrary がページごとに権限を再確認すること、フィルタリング後や空の結果が、見えない項目について何も明かさないことを確認してください。次に、文書とダイアグラムがひとつの一覧に混在するとき、タイトル検索、並び順、ページネーションがどう振る舞うかを確かめます。

Collection

定義Workspace 内で文書とダイアグラムを整理するためのグループ。Collection は最大5階層まで入れ子にでき、階層はナビゲーションを整理するもので、親から子へも子から親へもアクセス権を継承しません。

Topoloom での使い方Topoloom の製品キャプチャでは Engineering、Operations、Team Handbook といった Collection を使っています。Trust ページの権限ルールは Collection をひとつの付与対象として扱い、権限の境界としては扱いません。

お使いの環境で確かめること子の Collection は読めるが親は読めない場合に、その人に何が見えるかを確認してください。アーカイブや削除が連鎖するか、Collection を移動すると内容を読める人が変わることがあるかも確かめます。

Document Graph

定義Topoloomで人がオーサリングする内容から作られる、つながったモデルです。文書、ダイアグラム、ブロック、宣言、再利用可能オブジェクト、参照、関係、バージョンを安定したアイデンティティで結びます。

Topoloom での使い方Topoloomでは、文書とダイアグラムが寄与するオーサリング済みモデルをDocument Graphと呼びます。下流のContext Graphとは別で、Context Graphはエンティティを解決してエビデンスを付けられても、権限のある人の命令なしにオーサリング状態を書き込むことはありません。

お使いの環境で確かめることグラフが公開Contractで示すノードと関係の種類、PostgreSQLからの再構築方法、プロバイダーや検索投影が変更できるかを確認してください。グラフ状のモデルはグラフデータベースでも、正規の運用上の真実でもありません。

安定したアイデンティティ

定義各言及を無関係なコピーとして表すのではなく、オーサリング画面やバージョンをまたいで同じモデル化された概念を指すために使われる永続的な識別子。

Topoloom での使い方Topoloom は、文書、ダイアグラム、Runbook、SLO、レビュー、エクスポートにまたがる再利用を語るときにこの用語を使います。

お使いの環境で確かめること識別子のスコープ、ライフサイクル、マージ時の挙動、認可ルールを確認し、そのうえで名前変更、削除、復元、インポート、エクスポートの後にどう振る舞うかを確かめてください。安定したアイデンティティがあること自体は、記述が正しいことも最新であることも意味しません。

人がオーサリングしたナレッジ

定義オーサリングのワークフローにおいて、権限を持つ人が意図的に作成または確認したコンテンツや宣言。

Topoloom での使い方Topoloom は、人の意図と外部の観測が同じ状態として示されないように、人がオーサリングしたナレッジを提案や出所付きの外部コンテキストと対比します。

お使いの環境で確かめることどの操作が確認とみなされるか、誰がそれを実行できるか、どの来歴が記録されるか、修正や取り消しがどう表示されるかを確認してください。オーサリング済みであることは、独立して検証された運用上の事実を意味しません。

宣言

定義Serviceと所有者のように、ひとつの文書で人が確認する型付きの記述です。ソースブロックに紐づき、アイデンティティ、作成者、時刻、ライフサイクル、宣言済みの関係を記録します。

Topoloom での使い方Topoloom は宣言を段階的な形式化の最初の正式なステップとして示します。読みやすい文章はフォームにならずに宣言を得ます。宣言は、権限を持つ人が再利用可能オブジェクトに昇格させるか既存のオブジェクトにリンクするまで、その文書のローカルにとどまります。

お使いの環境で確かめること宣言がどのように作成、編集、リンク解除され、内容を失わずに通常のテキストへ戻せるかを確認してください。共同編集、取り消し、復元、エクスポートで何が保持されるかも確かめます。分析、インポート、プロバイダーのいずれも、人が受け入れない限り宣言を作らないことを確認してください。

再利用可能なナレッジオブジェクト

定義文書とダイアグラムが指せる、共有されたバージョン管理済みレコードです。権限を持つ人は新しい不変のオブジェクトバージョンを作ることでプロパティを変更し、以前のバージョンは残ります。

Topoloom での使い方Topoloom の Payment Service の例は再利用可能オブジェクトです。担当者、重要度、バージョンはキャプチャ S7 のオブジェクトページにあり、文書とダイアグラムはそれをアイデンティティで参照します。

お使いの環境で確かめることオブジェクトの作成に明示的な権限付きコマンドが必要なこと、名前が同じでもふたつのオブジェクトが統合されないことを確認してください。Used in の一覧に出るのが、閲覧を許可された不変の成果物バージョンだけであることも確かめます。オブジェクトの制限やトゥームストーン化が既存の参照にどう影響するかも尋ねてください。

参照

定義文書のブロックやダイアグラムのノードからひとつの再利用可能オブジェクトへのポインターで、対象の識別子と、follow-current または pinned のいずれかのバージョンを保持します。オブジェクトの権威あるプロパティを文書の内容にコピーすることはありません。

Topoloom での使い方Topoloom の「Reference, don't recopy」という約束はこの仕組みを指します。製品では参照に ↗ が付き、オブジェクトの共有プロパティはオブジェクトページで変わり、見えている表現は文書内で変わります。

お使いの環境で確かめることfollow-current 参照と pinned 参照の違い、そして対象が利用不可または未認可になったときに読者が何を見るかを確認してください。レンダリング、検索、エクスポート、公開のたびに、対象の権限が毎回確認されることも確かめます。

Knowledge Map

定義明示した範囲にある、宣言済みまたは参照されたナレッジを表示するビューです。ContentとMapは文書モードです。Mapは、閲覧を許可された選択済みソースも探索できます。

Topoloom での使い方Topoloomは各Mapのソース範囲を見える状態に保ちます。Mapはそのソースからナレッジを表示するもので、独立したオーサリング対象のDiagramではありません。

お使いの環境で確かめること各ソースの範囲と現在の閲覧権限を確認してください。文書Mapの編集が通常の保存と取り消しの経路を使うことも確認します。Mapは本番環境に何がデプロイされているかを証明しません。

セマンティックダイアグラム

定義ノードが再利用可能オブジェクトを参照でき、宣言されたエッジが型付きの関係を持つ独立したダイアグラム成果物。フリーフォームのコネクターは未宣言と表示されたままで、明示的なセマンティックエッジだけが関係の投影に入ります。

Topoloom での使い方Topoloom は、キャプチャ S6 で比較されている 決済承認の例 にセマンティックダイアグラムを使っています。明示的に実行した自動レイアウトは配置だけを整えます。矢印、近さ、色、レイアウトが関係を意味することはありません。

お使いの環境で確かめることどの種類のエッジが宣言済みとみなされるか、視覚表現のみのコネクターが色だけに頼らずどう表示されるかを確認してください。明示的な自動レイアウトが何を書き込むか、レイアウトやレンダラーが失敗しても宣言済みの関係が変わらないことも確かめます。

Structured fact

定義フォーム、制御された文、表、タブ区切りの行を使い、文書から関係を宣言する方法です。Topoloomは固定規則で入力を解決し、結果の変更をまとめて書き込むか、何も書き込みません。

Topoloom での使い方Topoloom は、同じスキーマへの2つ目の経路として、文章の選択の横に Structured fact を用意しています。曖昧な名前、古いエンドポイント、重複、自己参照エッジは何かが書き込まれる前に失敗し、あいまい一致やモデルは関与しません。

お使いの環境で確かめること入力を3つ実演してください。表からの一括入力、曖昧なエンドポイント、重複した関係です。文書ビューが現在の状態からファクトグループを表示すること、取り消しがバッチ全体を除去することを確認します。

Knowledge Review

定義保存済み文書に対して明示的に開始する分析で、宣言と関係を候補として提案します。現在の分析は、モデルを使わない決定的なオフラインの固定規則を適用します。候補は、人が項目ごと、または確認済みのバッチで受け入れるまで権威を持ちません。

Topoloom での使い方Topoloom の Trust のキャプチャ S3 は、Ready、Decisions、Represented のタブを持つ Knowledge Review を示しています。受け入れの際は各候補をロックされた現在の文書に照らして再導出し、書き込む前にその効果を開示します。暗黙に公開されることはありません。

お使いの環境で確かめること何が分析を開始するか、モデルやプロバイダーが呼び出されるかを確認してください。元のテキストが途中で変わった候補がどう扱われるか、同じ提案を2回受け入れても重複が生じないことも確かめます。提案が宣言済みとして示されることはありません。

成果物バージョン

定義ひとつの文書またはダイアグラムの、変更せずにアドレス指定して読める保存済みスナップショットです。内容、宣言、来歴、ソース位置、コンテンツハッシュを含みます。公開はライブドラフトではなく、このスナップショットを読みます。

Topoloom での使い方Topoloom のキャプチャ S6 にある Version 1 Baseline と Version 2 Current は成果物バージョンです。ひとつの再利用可能オブジェクトをスナップショットするオブジェクトバージョンや、通常のリビジョン履歴とは区別されます。

お使いの環境で確かめること公開済みバージョンを編集も消去もできないこと、復元が履歴を書き換えるのではなく新しいバージョンを作ることを確認してください。読み取りのたびに現在の人の権限が再確認されることも確かめ、お使いの環境でバージョン、オブジェクトバージョン、リビジョンがどう異なるかを尋ねてください。

来歴

定義ある項目がどこから来て、どのように現在の状態に至ったかについてのコンテキスト。読者がその権威と履歴を解釈する助けになります。

Topoloom での使い方Topoloom は来歴を、人の宣言、提案、外部の観測、バージョン、関係、レビュー、エクスポートに関連付けます。

お使いの環境で確かめること実際に記録されるフィールド、その出所、可変性、可視性、保持、エクスポート時の挙動を確認してください。来歴のラベルがあることは、元の情報源が正確であることを証明しません。

セマンティックレビュー

定義編集されたテキストやダイアグラムの配置に加え、アイデンティティ、所有、ライフサイクル、関係など、モデル化された意味の変更に焦点を当てたレビューです。

Topoloom での使い方Topoloomは二つの保存済みバージョンを比較し、所有者、依存関係、SLO、Decisionの変更を、行番号ではなく安定したアイデンティティに結び付けて読みやすく示します。キャプチャS6は、ひとつのダイアグラムの二つのバージョン間にある五つのsemantic changeを示します。

お使いの環境で確かめることどの変更の種類が検出されるか、影響がどう算出されるか、レビュー担当者が何を検査できるか、何がレビューの外に残るかを実演してもらってください。範囲はワークフローと設定によって異なる場合があります。

Knowledge Contract

定義統制された公開のための、バージョン管理された規則の集合です。テンプレート、必須・任意の構造、バリデーション、所有、レビューポリシーを組み合わせ、通常の下書き保存は許可します。

Topoloom での使い方Topoloom は Service Overview v1 という組み込みの契約をひとつ提供しています。管理された公開の前に Service 名と OWNED_BY Team を必須とし、重要度の高い Service に SLO や Runbook のリンクがないと警告します。不完全なドラフトは引き続き保存でき、一般的な契約の作成は後のガバナンス段階です。

お使いの環境で確かめることバリデーションが止めるのは管理された公開だけで、通常の保存は決して止めないことを確認してください。公開が、承認済みレビューとあわせて正確な成果物バージョンとオブジェクトバージョンを評価することも確かめます。免除には権限、理由、範囲、有効期限、監査記録が必要であることを確認してください。

アクセス権付与

定義人またはグループに Collection、文書、オブジェクトを読み取り、編集、管理するために明示的に与える権限です。各付与には理由と有効期限、または意図的な恒久設定が記録され、PostgreSQL がアクセスの権威であり続けます。

Topoloom での使い方Topoloom の Trust の統制は権限を意識した画面を説明しており、アクセス権付与はその背後にある仕組みです。期限付きの付与は5分から365日まで有効で、有効期限は認可が読むデータベースビューが強制します。キャッシュ、ワーカー、ブラウザーの状態が、期限切れの付与を許可に変えることはありません。

お使いの環境で確かめることWorkspace ロールの上限と、人が停止、再有効化、削除されたときに付与がどうなるかを確認してください。最後の有効な管理者を削除できないこと、期限切れの付与が、更新できる管理者にどう見えるかも確かめます。

Living Binding

定義比較と人による明示的な操作のために、出所付きの外部コンテキストをオーサリングされた宣言の横に置く接続。

Topoloom での使い方TopoloomはLiving Bindingで、オーサリング状態と外部ソースからの観測を見える形で分けます。プロバイダーの証拠にはプロバイダー名と確認時刻が残ります。検証済みの参照ワークフローは模擬プロバイダーを使うため、実際のコネクターは別途確認してください。

お使いの環境で確かめること対応するソース、更新の挙動、出所の表示、失敗や古い状態のラベル、権限チェック、外部の入力がオーサリングされたナレッジになる前に必要な操作を確認してください。

Portable Knowledge Package

定義Topoloom の外で検査できるよう、読めるナレッジとバージョン管理された構造化コンテキストを一緒に持ち運ぶ、範囲を定めたエクスポート。

Topoloom での使い方Topoloomは、読める内容、安定したアイデンティティ、バージョン、関係、来歴、レビュー、権限マッピング、明示的な損失レポートが一緒に移動することをこの用語で表します。ソース参照付きDiagramのエクスポートにはtopoloom.package/4を使い、/1から/3の形式も読み取れます。キャプチャS8は完了したエクスポートを示すだけで、アーカイブの中身を示すものではありません。

お使いの環境で確かめること含まれる形式とフィールドの正確な一覧を求め、省略と変換を検査し、パッケージを Topoloom の外で開いてください。パッケージの名称だけでは完全性の保証にはなりません。

用語は慎重に

用語を定義する。 そして挙動を検証する。

評価ガイドは、これらの定義を範囲付きのワークフロー、権限とデータに関する問い、エクスポートの確認、判断のチェックリストに変えます。

製品の画面