「質問ガイド作成(ソースコードの確認用)」の使い方
開発ドキュメントとソースコードのアーカイブをアップロードして、実装を担当した方に確認したい点を質問の形に整理する、質問ガイド作成(ソースコードの確認用/β版)の操作手順と結果の見方について
想定読者
PARAs AIの質問ガイド作成(ソースコードの確認用)を実際に使って、結果の読み方を把握したい方
注意点
この機能は、実装の欠陥・不備・過失・不正の有無を判定するものではありません。実装担当者に確認する質問の候補を提案する、参考情報です。
目次
「質問ガイド作成(ソースコードの確認用)」の使い方
質問ガイド作成(ソースコードの確認用/β版)は、開発ドキュメントとソースコードを突き合わせて、実装を担当した方(実装担当者)に確認したい点を「質問」の形に整理して提示する機能です。
この機能は、Python・JavaScript・TypeScript・Java・PHPのソースコードと、要求や設計が書かれた開発ドキュメントを入力として想定しています。
この機能を使うのは、コードと開発ドキュメントの内容を確認する「確認者」です。開発ドキュメントは、機能要求定義書のように、確認者自身が提出する場合もあれば、実装担当者が提出する場合もあります。確認者は、実装担当者に確認したい点を、PARAs AIが整理した質問の形でたずねます。コードとドキュメントや、実装担当者の回答は、確認者がPARAs AIに入力します。
情報の流れは、開発ドキュメントを誰が提出するかによって、次の2通りがあります。
作成される質問は、次の2つの区分に分かれます。
- 実装漏れの疑い: 開発ドキュメントの要求に対応するコードが見当たらない箇所について、どこで実現しているかを確認する質問です。
- 余分な実装の疑い: どの要求にも対応しないコードについて、何のために実装したか、なぜ残しているかを確認する質問です。
さらに、実装担当者の回答をその場で入力して、回答の適合度と、回答から読み取れる傾向を確かめることもできます。
ご注意 この機能は、実装の欠陥・不備・過失・契約違反・不正があることを断定せず、ないことも保証しません。質問に答えられないことや、回答の分析に差異が示されることは、何らかの結論を裏づけるものではありません。逆に、差異が示されないことも、同様です。コードレビュー、セキュリティ診断、脆弱性検査、品質保証、ライセンスの適合性確認、契約上の検収の代わりにもなりません。質問の妥当性は人間が確認し、最終的な判断はご自身で行なってください。
この機能でできること
- アップロードしたコードと開発ドキュメントから、実装担当者に確認したい質問を作成します。
- 質問を、「実装漏れの疑い」と「余分な実装の疑い」の2つの区分に分けて、疑わしい順に表示します。
- 各質問に、確認の対象と質問の意図を添えて表示します。
- 各質問に、検知の根拠(ドキュメントの引用、最も近いコードまたは対象のコードなど)を添えて表示します。
- 質問ごとに「確認済み」のチェックを付けて、確認の進み具合を管理できます。
- 質問に対する実装担当者の回答を入力して、回答を分析できます。
- 作成した質問ガイドを、あとからプロフィールで見返せます。
この機能でできないこと
- 実装の欠陥・不備・過失・契約違反・不正の有無についての判定。
- コードレビュー、セキュリティ診断、脆弱性検査、品質保証、ライセンスの適合性確認、契約上の検収の代わりとなること。
- 実装漏れや余分な実装の網羅的な検出。示されなかったことは、実装漏れや余分な実装がないことを意味しません。
- 質問の妥当性の保証。質問が適切かどうかは、ご自身で確認してください。
- 回答した方の心理状態や、回答の背景にある事情の断定。
- Python・JavaScript・TypeScript・Java・PHP以外の言語や、画像の文字の読み取りが必要なPDFの解析。
利用の条件
- ログインしている方がご利用いただけます。
- β版の機能です。
- ポイントが必要です。アップロードしたコードと開発ドキュメントの行数に応じて、生成の開始時にポイントを消費します(詳しくは、「3. 消費ポイントを確認して、生成する」をご覧ください)。
- 作成した質問ガイドは、作成した本人だけが閲覧できます。
使い方
1. ページを開く
ヘッダーのメニュー「コミュニケーション分析」から「質問ガイド(ソースコードの確認)」を選びます。
2. コードと開発ドキュメントを選ぶ
次の2つを、それぞれ別のアーカイブにまとめて用意します。
- コード: 解析したいソースコードをまとめたアーカイブです。
- 開発ドキュメント: 要求や設計が書かれたドキュメントをまとめたアーカイブです。
「1. コード」と「2. 開発ドキュメント」のそれぞれの枠をクリックしてアーカイブを選ぶか、枠の上にアーカイブをドラッグ&ドロップします。
| 項目 | 条件 |
|---|---|
| 対応しているアーカイブの形式 | zip・tar・tar.gz(tgz)。形式は、拡張子ではなく、ファイルの内容で判定されます。 |
| コードの対象 | Python(.py)、JavaScript(.js・.jsx・.mjs・.cjs)、TypeScript(.ts・.tsx・.mts・.cts)、Java(.java)、PHP(.php) |
| 開発ドキュメントの対象 | Markdown・テキスト・Word・PDF(.md・.markdown・.txt・.docx・.pdf)。PDFは、文字情報を含むものに限ります。 |
| アーカイブ1つの大きさとファイル数 | 上限は、画面に表示されます。 |
| 個数 | コードのアーカイブ1つと、開発ドキュメントのアーカイブ1つ |
次のものは、解析の対象外です。対象外のファイルで実現されている要求は、「対応するコードがない」として扱われ、実装漏れの疑いとして示される場合があります。
- 型定義ファイル(.d.ts)、圧縮(minify)済みのファイル
- テストのコード(test・tests・specなどのフォルダ、test_〜.py、〜.test.ts、〜Test.javaなど)
- 依存物・生成物のフォルダ(node_modules・vendor・dist・buildなど)
- 隠しファイル(名前が「.」で始まるもの)
- 1ファイルが大きすぎるコード(約1MB超)
- 上記以外の言語・形式のファイル(設定ファイルを含みます)
アーカイブが選ばれると、その場でアップロードが始まります(「この内容でガイドを生成する」を押す前です)。アップロードの前に、お使いのブラウザの中でアーカイブを展開して、行数を数えます。完了すると、ファイル名、対象のファイル数、行数が表示されます。
- 「別のファイルに差し替える」を押すと、アーカイブを選び直せます。以前のアーカイブは削除されます。
- 「削除」を押すと、アップロードしたアーカイブを取り消せます。取り消したアーカイブは、削除されます。
- 質問ガイドを作成しないまま画面を離れた場合も、アップロードしたアーカイブは削除されます。
コードと開発ドキュメントの両方のアップロードが完了するまでは、「この内容でガイドを生成する」は押せません。
最後に、「区分ごとの質問数(上位)」を指定します。「実装漏れの疑い」と「余分な実装の疑い」のそれぞれについて、疑わしい順にこの件数までを質問にします。指定できる範囲は画面に表示され、既定は5件です。質問数を変えても、消費ポイントは変わりません。
3. 消費ポイントを確認して、生成する
画面の「消費ポイントの見積もり」には、次の内容が表示されます。
- コードとドキュメントの行数: ファイルごとの内訳(行数の多い上位5件まで)と、それぞれの合計行数です。
- 消費ポイント: 「0.765 ×(コードの行数 + 開発ドキュメントの行数)」で計算した、消費するポイントです。小数点以下は切り上げます(例:合計1,000行なら765ポイント、4,280行なら3,275ポイント)。
- 現在の保有ポイント: いまお持ちのポイントと、作成後の残りです。
行数は、空行(空白・タブ・全角空白だけの行)を除き、解析の対象になるファイルだけを数えます。
ファイルを選んだ直後の行数は、お使いのブラウザで数えた「見積もり」です。アップロードの完了後に、当サービスのサーバーが行数を数え直して確定し(表示が「確定」に変わります)、確定した行数でポイントを消費します。PDFの本文などでは、見積もりと確定で差が出る場合があります。
ポイントは、「この内容でガイドを生成する」を押した時点で、一括して消費されます。ポイントが足りない場合は、不足分が表示され、チャージ用のボタンが表示されます。
問題がなければ、「この内容でガイドを生成する」を押します。
- 生成には、通常、数分から十数分かかります(入力が大きい場合は、それ以上かかることがあります)。生成中は、「生成中です」と、いま進んでいる段階が表示されます。
- 生成中に画面を閉じても、生成は続きます。完了後に、プロフィールの「質問ガイド」から結果を確認できます。
- 生成に失敗した場合は、消費したポイントが返金されます。結果が長時間(2時間を目安)出ない場合も、失敗として扱われ、返金されます。
4. 結果を見る
結果の見方は、次の章をご覧ください。
結果の見方
画面の構成
結果の画面は、上から順に次のように並びます。
- アップロードしたアーカイブの元のファイル名(「コード / ドキュメント」)
- サマリー
- 質問の区分ごとの一覧(実装漏れの疑い → 余分な実装の疑い)
サマリー
| 項目 | 内容 |
|---|---|
| 質問 | 作成された質問の件数。 |
| 解析した範囲 | 解析したコードのファイル数(関数・クラスなどの単位の数)と、ドキュメントのファイル数(取り出した要求文の件数)。 |
| 確認済み | チェックを付けた質問の件数と、進み具合を示すバー。 |
質問の区分
質問は、区分ごとにセクションに分かれて表示されます。各区分には、見出しと件数、説明文が付きます。区分の中の質問は、疑わしい順に並びます。
| 区分 | 確認する内容 |
|---|---|
| 実装漏れの疑い | ドキュメントの要求に対応するコードが見当たらない箇所について、どこで実現しているかを確認する質問。 |
| 余分な実装の疑い | どの要求にも対応しないコードについて、何のために実装したか、なぜ残しているかを確認する質問。 |
質問が1件も作られなかった区分は、表示されません。質問は、検知の結果をもとに、あらかじめ用意した定型の言い回しの候補から組み立てています。一度作成した質問の文面は、画面を開き直しても変わりません。
質問の読み方
各質問は、実装担当者へそのままたずねられる文章で表示されます。質問の下には、次の補足が付くことがあります。
| 補足 | 内容 |
|---|---|
| 対象 | その質問が、どの要求や、どのコードについてのものか。 |
| 意図 | その質問で、何を確かめようとしているか。 |
「対象」と「意図」は、質問をたずねる前に、その質問が自分の目的に合っているかを確かめるための付加情報です。
質問をクリック(タップ)すると、「確認済み」のチェックが付きます。もう一度押すと、外れます。チェックは自動的に保存されます。確認の進み具合は、サマリーのバーに反映されます。
検知の根拠を見る
各質問の下の「検知の根拠を見る」を押すと、その質問のもとになった検知の根拠が開きます。
| 項目 | 内容 |
|---|---|
| ドキュメントの要求(実装漏れの疑い)/最も近い要求(余分な実装の疑い) | ドキュメントからの引用です。引用元のファイル名と、行・ページ・節の位置が添えられます。 |
| 最も近いコード(実装漏れの疑い)/対象のコード(余分な実装の疑い) | コードのファイル名、関数名・クラス名、行番号、コードの説明と抜粋です。入力内の他のコードからの呼び出し件数(推定)が表示される場合があります。 |
| コード側で見つからなかった具体値 | 要求に書かれている具体的な値のうち、コード側で見つからなかったもの。 |
| 判定で最も近かった相手との近さ | 目安のパーセントです。低いほど、対応する可能性が低いと判定されたことを示します。確率や、正誤を保証するものではありません。 |
根拠は、質問の妥当性を確かめるための材料です。表示された根拠から、実装漏れや余分な実装があると断定することはできません。
結果に表示される注意
- 「ドキュメントから要求文を取り出せなかったため、実装漏れの検知と余分な実装の検知は行っていません」:ドキュメントに、要求や仕様として読み取れる文がなかった場合に表示されます。
- 「解析できず、除外されたファイルが○件あります」:構文エラーや、文字情報のないPDFなどが、解析から除外されています。
- 「実装漏れの疑い・余分な実装の疑いは検知されませんでした」:該当が検知されなかったことを示します。問題がないことの保証ではありません。
回答を分析する
各質問の下には、「実装担当者の回答」の入力欄があります。
- 「実装担当者の回答」欄に、実装担当者の回答を入力します(5000文字まで)。
- 「回答を分析する」を押します。1回の分析につき、5ポイントを消費します。
- 分析中は「分析中です」と表示されます。完了すると、結果が表示されます。
分析結果として、次の2つが表示されます。
- 回答の適合度: 質問に対して、回答がどの程度適合しているかを、パーセントで示します。
- 回答から読み取れる傾向: 「平常心」「狼狽」「喪失感」「嫌悪感」「恐怖心」の5つの区分が、それぞれどの程度の割合で読み取れたかを示します。
5つの区分の合計が100%になる、相対的な割合です。最も大きい区分が目立つ形で表示されます。5つの区分に大きな偏りがない場合は、「傾向は明確ではありません」と表示されます。
回答を編集したあとは、結果の上に「回答が編集されています」と表示されます。表示されている結果は、最後に分析した回答に対するものです。編集後の回答を分析するには、もう一度「回答を分析する」を押してください。
分析に失敗した場合は、消費したポイントが返金されます。
過去の質問ガイドを見返す
プロフィールの「質問ガイド」タブで、「ソースコードの確認用」を選ぶと、これまでに作成した質問ガイドの一覧が表示されます。ファイル名、質問、対象、根拠で検索もできます。一覧から開くと、質問、根拠、チェックの状態、入力した回答と分析結果を見返せます。
ただし、ソースコードの確認用の結果と入力した回答は、作成から30日を目安に自動的に削除され、削除後は見返せません。必要な内容は、事前にお手元に控えてください。
読み方の注意
- 質問ガイドは、AIの処理で作られた、参考情報です。コードとドキュメントの対応関係の判定には、検知漏れや誤検知などの誤差が生じます。
- 「実装漏れの疑い」は、ドキュメントの要求に対応する実装があるのに、示される場合があります。設定ファイル、外部サービス、データベース、テストのコード、解析の対象外の言語・ファイルで実現されている要求は、対応するコードがないものとして扱われることがあります。
- 「余分な実装の疑い」が示されないことは、余分な実装がないことを意味しません。
- 質問は、疑わしい順に、指定した件数までを示すものです。指定した件数を超える箇所は、質問にしていません。
- 質問の妥当性は、ご自身で確認してください。そのまま使わず、状況に合わない質問は外して構いません。
- 質問に答えられないこと、または回答の分析に差異が示されることは、実装担当者の能力、過失、代筆、盗用その他の不正を示すものではありません。
- 回答の分析結果は、回答の内容を相対的に整理して表示するものです。回答した方の心理状態を断定するものではありません。
- 質問ガイドや分析結果を、実装担当者や他の方に示すときは、これらの性質をあわせてご説明ください。
ご利用にあたって
- アップロードしたコードと開発ドキュメントは、ブラウザから当サービスが指定するクラウドストレージへ直接送信され、解析のために、当サービスが運営する解析サービスに取り込まれます。解析では、AIモデルによる処理(コードの内容の説明の作成、ドキュメントの文の分類、要求とコードの対応の判定)が行われます。
- アップロードしたアーカイブは、解析が完了または失敗した時点で削除されます。「削除」や差し替えをしたとき、生成を実行せずに画面を離れたときも削除されます。
- 作成された質問ガイド(質問、根拠として表示するドキュメントの引用とコードの抜粋・説明・ファイル名・行番号、確認済みのチェック、入力した回答、回答分析の結果)は、作成した本人のみが閲覧できます。作成から30日を目安に、自動的に削除されます。
- 回答の分析では、入力した回答と、その前提となる質問文(ドキュメントの引用、ファイル名、関数名・クラス名、行番号を含みます)が、外部の分析用APIに送信されます。
- アップロードの前に、パスワード・APIキー・秘密鍵・トークンなどの認証情報や、実在の個人に関する情報(本番データ、ログ)を、削除または置き換えてください。
- 勤務先や顧客のコードは、必要な許可を得てからアップロードしてください。アップロードする権限のないコードやドキュメントは、アップロードできません。
- 詳しくは、利用規約の「第8条の8(ソースコードの確認用の質問ガイド作成機能について)」をご確認ください。
よくある質問
Q. アップロードがエラーになります。
画面に表示される内容に応じて、次をご確認ください。
- 「対応している形式は zip・tar・tar.gz(tgz)です」:アーカイブの中身が、zip・tar・tar.gz のいずれかである必要があります。
- 「ファイルサイズが大きすぎます」:上限は画面に表示されます。対象のフォルダだけにして、作り直してください。
- 「解析できるコード/ドキュメントが見つかりませんでした」:対象の言語・形式のファイルが含まれているか、テストや隠しファイルしかないなどの理由で対象外になっていないかをご確認ください。
- 「ファイル数が上限を超えています」:コードと開発ドキュメントのそれぞれに上限があります。解析したい範囲に絞ってください。
- 「「..」や絶対パスを含むアーカイブは使えません」「リンクを含むアーカイブは使えません」「特殊ファイルを含むアーカイブは使えません」:安全上の理由で受け付けません。該当するものを除いて、作り直してください。
- 「壊れている」「暗号化されている」:パスワードなしの、壊れていないアーカイブで作り直してください。
- 「エントリ数/展開後の合計サイズが上限を超えています」:アーカイブの中身を減らしてください。
- 「お使いのブラウザは tar.gz の展開に対応していません」:zip にして、もう一度お試しください。
受け付けられなかったアーカイブは、削除されます。
Q. 「この内容でガイドを生成する」が押せません。
コードと開発ドキュメントの両方のアップロードが完了していない可能性があります。それぞれの枠にファイル名と「確定」の表示が出るまでお待ちください。
Q. 消費ポイントは、どう決まりますか。
「0.765 ×(コードの行数 + 開発ドキュメントの行数)」で、小数点以下は切り上げです。行数は、空行を除き、解析の対象になるファイルだけを数えます。質問数(上位)を変えても、消費ポイントは変わりません。回答の分析は、1回につき5ポイントです。
Q. 見積もりと、確定の行数が違います。
ファイルを選んだ直後の行数は、ブラウザで数えた見積もりです。アップロード後に、サーバーが数え直して確定します。PDFの本文などでは、差が出る場合があります。ポイントは、確定した行数で消費されます。
Q. 生成が終わりません。
生成には、通常、数分から十数分かかります(入力が大きい場合は、それ以上かかることがあります)。生成中に画面を再読み込みしたり、閉じたりしても、生成は続きます。完了後に、プロフィールの「質問ガイド」から確認してください。結果が長時間(2時間を目安)出ない場合は、失敗として扱われ、消費したポイントが返金されます。
Q. 「生成に失敗しました」と表示されました。
コードの関数・クラスの数や、ドキュメントの文の数が上限を超えた場合などに失敗します。上限は、作成画面の注意書きに表示されます。消費したポイントは返金されますので、コードやドキュメントを解析したい範囲に絞って、新規に作成し直してください。
Q. 質問が表示されません。
「実装漏れの疑い・余分な実装の疑いは検知されませんでした」と表示された場合は、該当が検知されなかったことを示します(問題がないことの保証ではありません)。「ドキュメントから要求文を取り出せなかったため〜」と表示された場合は、ドキュメントに要求や仕様として読み取れる文がなかったことを示します。要求・仕様が文章で書かれたドキュメント(PDFは文字情報を含むもの)をご用意ください。
Q. 「実装漏れの疑い」とされた要求は、本当に実装されていないのですか。
そうとは限りません。実装があるのに示される場合があります。設定ファイル、テストのコード、対応していない言語のコードなどで実現されている要求は、「対応するコードがない」として扱われることがあります。質問は、実装担当者に確認するきっかけとしてご利用ください。
Q. 同じ入力なのに、実行のたびに質問が変わります。
AIの処理で作成しているため、同じコードとドキュメントでも、質問の内容が変わることがあります。一度作成した質問の文面は、画面を開き直しても変わりません。
Q. 結果を、あとから見返せますか。
作成から30日を目安に、プロフィールの「質問ガイド」タブの「ソースコードの確認用」から見返せます。それ以降は、結果と入力した回答が自動的に削除され、見返せません。
Q. 「回答を分析する」が、分析中のまま進みません。
結果の受信に時間がかかっている可能性があります。10分ほど待っても結果が表示されない場合は、「結果の受信に時間がかかっています」と表示されます。その場合は、もう一度「回答を分析する」を押してください。
Q. 「保存に失敗しました」と表示されました。
確認済みのチェックを保存できませんでした。通信状態をご確認のうえ、もう一度チェックを付けてください。