最初に共有したい四つの情報
- 対象と参照仕様
- 対象のサービスや連携、参照資料の名称・版。資料が手元にない場合はその旨を記します。
- 実現したい処理
- 取得、登録、更新など、何を行いたいかと、期待する結果。
- 実際の結果
- 実行した日時、応答の種類やコード、表示されたメッセージなど、分かる範囲で。
- 確認した条件
- 利用環境、同じ条件で繰り返すか、変更した条件とその結果。
相談の段階によって、確認点は変わります
| 相談の段階によって、確認点は変わります | 整理する内容 | 確認したい点 |
|---|---|---|
| 利用を検討している | 連携したいサービスと、行いたい処理。 | 対象となるAPIの提供や利用条件、仕様の確認先。 |
| 実装の方法を確認したい | 参照仕様と、分からない項目。 | 入力形式、返却内容、必要な条件の読み方。 |
| 実行結果が想定と違う | 同じ操作をたどれる手順と、期待・実際の結果。 | 仕様との差、再現する条件、まだ確かめていない点。 |
再現情報を、共有できる形に整える
- 対象の処理を絞る
どの操作で問題が起きるかを整理します。影響のある登録や更新を、再現のために繰り返す必要はありません。
- 順序と条件を残す
参照した仕様、操作の順序、確認日時、利用環境を控えます。想定と違う部分を短くまとめます。
- 共有する情報を確かめる
認証用の値、個人情報、契約上共有できないデータを除きます。ログ全文ではなく、必要な項目と結果を本文にまとめます。
- 不足している情報も伝える
資料の版が不明、再現を試せないなど、確認できていない点をそのまま記します。
具体的な接続先と利用条件は、対象の仕様で確認する
ここでは、技術的な相談に必要な情報のまとめ方を案内しています。公開APIの接続先、認証方式、利用料金、上限値を定める仕様書ではありません。
対象の資料が見つからない場合は、サービス名と連携したい内容をお問い合わせください。実在する接続先や利用許可が確認できるまでは、例から推測して接続する必要はありません。
APIの相談を送る前に
資料がまだなくても相談できますか。
対象のサービスと、実現したい連携をお伝えください。APIの提供や利用条件が未確認であることも、あわせて記載できます。
認証に使う値やログをそのまま送ればよいですか。
認証用の値は送らず、ログに含まれる個人情報や共有できないデータを除いてください。問題の操作と必要な結果を、本文へまとめます。
エラーのコードだけで原因は分かりますか。
同じコードでも確認する条件が異なる場合があります。対象の仕様、行った処理、実際の結果をあわせて伝えると、状況を共有しやすくなります。