開発者向け文書

リリースと移行

リリース、マイグレーション、互換性、廃止ポリシーを説明します。

運用12
ローカル開発環境の実キャプチャ
調査系の文書では、検索、ログ、関連文書への移動を同じ流れで確認できるようにします。
ローカル開発環境で撮影した文書検索画面

操作前の確認

実装前にAPI、認証、権限、ログの責務を切り分けます。

標準手順

画面で再現できる状態を作り、APIレスポンスとログを同じ時刻で突き合わせます。

証跡の残し方

連携失敗時はレスポンス、アクセスログ、監査ログ、外部通知の配送履歴をそろえて調査します。

この文書で扱う機能

画面ガイド

実際のコンソール導線に合わせて、対象機能、操作ステップ、確認ポイントを画面例で追えるようにしています。

/docs/developers
ナビゲーション
監査ログ
設定/権限
管理基盤
監査ログ
1
段階移行
2
互換URL
3
マイグレーション

確認ポイント

1. 段階移行
2. 互換URL
3. マイグレーション
関連文書を検索
公開文書への移行とリリース

内部マニュアルを外部文書へのリンクに切り替えつつ、互換URLと移行手順を維持します。

段階移行

旧LPや内部マニュアルはすぐ削除せず、公開文書へのリンクハブを経由して移行します。

1. 段階移行 の確認観点
対象組織と権限が揃っていることを確認する
画面操作とAPI呼び出しで同じデータを見ていることを確認する
失敗時にアクセスログまたは監査ログで追跡できることを確認する

APIだけを見て判断せず、画面の権限ガード、組織コンテキスト、外部通知やログの記録まで含めて確認します。

1. 段階移行 の確認フロー

実装前提、画面/API、ログの3点を同じ時刻で追える形にします。

互換URL

既存URLは対応先へ誘導し、利用者のブックマークや社内案内を壊さないようにします。

2. 互換URL の確認観点
対象組織と権限が揃っていることを確認する
画面操作とAPI呼び出しで同じデータを見ていることを確認する
失敗時にアクセスログまたは監査ログで追跡できることを確認する

APIだけを見て判断せず、画面の権限ガード、組織コンテキスト、外部通知やログの記録まで含めて確認します。

2. 互換URL の確認フロー

実装前提、画面/API、ログの3点を同じ時刻で追える形にします。

マイグレーション

DB変更を伴う場合はマイグレーションルールを確認し、スキーマとSQLをセットで扱います。

3. マイグレーション の確認観点
対象組織と権限が揃っていることを確認する
画面操作とAPI呼び出しで同じデータを見ていることを確認する
失敗時にアクセスログまたは監査ログで追跡できることを確認する

APIだけを見て判断せず、画面の権限ガード、組織コンテキスト、外部通知やログの記録まで含めて確認します。

3. マイグレーション の確認フロー

実装前提、画面/API、ログの3点を同じ時刻で追える形にします。