メインコンテンツへスキップ

Documentation Index

Fetch the complete documentation index at: https://craft-support.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

ドキュメントレビューは、文章に対して構造化された実用的なフィードバックを提供します。Assistantに一般的な質問をする代わりに、ドキュメントレビューはドキュメント全体を分析し、構造・明瞭さ・完全性・全体的な品質についてインサイトを提供します。 これにより、共有前の問題点の発見、コンテンツ品質の改善、作業への外部的な視点の獲得が可能になります。すべてCraftを離れることなく行えます。

ドキュメントレビューの機能

ドキュメントレビューは複数の観点からドキュメントを分析します: 構造と整理:
  • 論理的な流れと展開
  • 見出し階層の一貫性
  • セクションのバランスとペース
  • 情報のアーキテクチャ
明瞭さと読みやすさ:
  • 文の複雑さと長さ
  • 専門用語や技術的言語の使用
  • アイデア間のつながり
  • 総合的な読みやすさスコア
完全性:
  • コンテキストや背景の欠落
  • 説明のギャップ
  • 未回答の質問
  • 展開が必要な部分
品質シグナル:
  • トーンの一貫性
  • 書式の問題
  • 冗長性と繰り返し
  • 改善の機会
レビューは客観的・具体的・実用的で、具体的な提案が得られます。漠然とした感想ではありません。

ドキュメントレビューの開始方法

1
レビューしたいドキュメントを開きます。
2
画面下のコーナーにあるAssistantアイコンをクリックします。
3
新規チャットを選択します。
4
モードセレクターからドキュメントレビューを選びます。
5
分析の完了を待ちます(通常10〜30秒)。
Assistantがドキュメント全体を読み込み、カテゴリ別に整理されたフィードバックを提供します。
ドキュメントレビューはすべてのモデルで動作しますが、Maxが最も詳細で深いフィードバックを提供します。特に長文や複雑なドキュメントに適しています。素早い確認には、Fastが深さとスピードのバランスが良い選択肢です。

ドキュメントレビューと通常のAssistantチャットの違い

機能ドキュメントレビュー通常のAssistantチャット
目的構造化されたドキュメントフィードバック自由形式の会話とタスク
スコープドキュメント全体の分析特定の質問への回答
出力形式フィードバックカテゴリ別に整理会話形式の返答
分析の深さ包括的・多次元的特定の質問に焦点
最適な用途品質チェック、公開前レビュー素早い編集、要約、コンテンツ照会
フォローアップ確認質問が可能継続的な会話
使用量多め(ドキュメント全体を分析)クエリの複雑さによる
ドキュメント全体への包括的なフィードバックが必要な場合はドキュメントレビューを使用してください。特定の質問やタスクがある場合は通常のチャットを使用してください。

ドキュメントレビューが特に役立つ場面

外部共有前

プレゼンテーション、提案書、クライアント向けドキュメントを送付前にレビューして、構造上の問題、不明確なセクション、コンテキストの欠落を確認しましょう。

品質保証

重要なドキュメント、チームのウィキ、ナレッジベース記事に定期的なレビューを実施して、高品質と一貫性を長期的に維持しましょう。

コンテンツの改善

ブログ記事、レポート、長文コンテンツに対して実用的な提案を得られます。Assistantは展開・簡潔化・再構成が必要な部分を特定できます。

コラボレーション準備

チームメンバーと共有する前に、ドキュメントが明確で完全で整理されていることを確認しましょう。これにより手戻りが減り、コラボレーションの効率が向上します。

学習とスキル開発

レビューを活用して文章のパターンを理解しましょう。繰り返す明瞭さの問題、構造的な傾向、継続的に改善が必要な部分を把握できます。
ドキュメントレビューは何度でも実行できます。フィードバックに基づいて変更を加えた後、再度レビューして問題が解決されたか確認しましょう。この反復的なアプローチによって、何が効果的かを学びながらコンテンツを段階的に改善できます。

フィードバックの解釈方法

ドキュメントレビューのフィードバックは明確なカテゴリに整理されています。解釈と活用方法をご説明します:

構造のフィードバック

内容: コンテンツの流れ、セクションのバランス、情報アーキテクチャの適切さ。 フィードバック例:
  • 「導入部がドキュメント全体に比べて長すぎます」
  • 「セクション3にはセクション2からの明確なつながりがありません」
  • 「見出し階層がH2からH4に飛んでいます」
活用方法: セクションの再構成、ペースの調整、見出しレベルの修正、つなぎコンテンツの追加。

明瞭さのフィードバック

内容: 文章が読みやすいか、文が複雑すぎないか、読者が混乱しやすい箇所。 フィードバック例:
  • 「この段落は受動態が多く、読みにくくなっています」
  • 「最初のセクションの専門用語が非専門家の読者を混乱させる可能性があります」
  • 「文の平均長が35語です。より短い文に分割することを検討してください」
活用方法: 文の簡潔化、専門用語を平易な言葉に置き換え、技術用語の定義を追加。

完全性のフィードバック

内容: コンテンツのギャップ。コンテキストの欠落、未回答の質問、詳細が必要な部分。 フィードバック例:
  • 「ドキュメントで『新しいプロセス』に言及していますが、定義されていません」
  • 「ステップ2と3は、導入部でカバーされていない事前知識を前提としています」
  • 「結論や次のステップが記載されていません」
活用方法: 背景の追加、薄いセクションの拡充、要約と結論の追加。

品質のフィードバック

内容: トーンの一貫性、書式の問題、コンテンツを磨く機会。 フィードバック例:
  • 「セクション間でフォーマルとカジュアルのトーンが入れ替わっています」
  • 「箇条書きの書式が一貫していません(句点で終わるものと終わらないものがあります)」
  • 「この概念が2回説明されています。統合することを検討してください」
活用方法: 書式の統一、一貫したトーンの維持、冗長性の削除。

使用量

ドキュメントレビューは、ドキュメント全体を一度に分析するため、シンプルな質問よりもAIクォータを多く消費します。長く複雑なドキュメントほど多く使用します。素早く軽いレビューにはFastを使用してください。
実際の使用量はドキュメントの長さ、構造、書式の複雑さ、選択したモデルによって異なります。Assistantメニューの使用量と制限で使用量を確認できます。
包括的なフィードバックは多くの場合、複数の個別クエリよりも時間を節約し、品質を効率よく向上させます。

より良いレビューのためのヒント

1. 事前にドキュメントを準備する レビューを実行する前に、ドキュメントがある程度完成していることを確認してください。Assistantは粗いアウトラインよりも完成した下書きに対してより良いフィードバックを提供します。 2. 対象読者を指定する フォローアッププロンプトで、Assistantにドキュメントの対象読者を伝えてください:
  • 「製品に精通した技術チーム向けです」
  • 「対象読者は非技術系のステークホルダーです」
  • 「Craftを一度も使用したことのない新規ユーザー向けに書かれています」
このコンテキストによりAssistantはフィードバックをあなたの特定のニーズに合わせて調整できます。 3. 優先度付きフィードバックを依頼する レビューで多くの問題が見つかった場合、Assistantに優先順位をつけてもらいましょう:
  • 「最初に修正すべき3つの問題はどれですか?」
  • 「最も重要な構造上の問題は何ですか?」
  • 「明瞭さの問題だけに集中してください」
4. 特定の種類のフィードバックを依頼する 集中的な分析を依頼してレビューを導くことができます:
  • 「トーンの一貫性についてレビューしてください」
  • 「完全性と欠落しているコンテキストのみを確認してください」
  • 「初心者向けに構造が適切かどうかに集中してください」
5. 適切なモデルを使用する
  • オンデバイス: ドキュメントレビューには非推奨(コンテキスト制限あり)
  • Core: 短いドキュメントの素早い構造チェック
  • Fast: ほとんどのレビューに適したバランス(500〜2000語)
  • Max: 長く複雑なドキュメント、または最も詳細なフィードバックが必要な場合に最適

例:ブログ記事の公開前

SarahがCraftのコレクションの使い方についてブログ記事を書きました。公開前に、内容が明確で完全であることを確認したいと思っています。
1
Sarahは下書きのブログ記事をCraftで開きます。
2
Assistantアイコンをクリックしてドキュメントレビューを選択します。
3
Assistantがドキュメントを分析してフィードバックを提供します:
  • 構造:「導入部は良いですが、セクション2がセクション3と4を合わせたより2倍の長さです。2つに分割することを検討してください。」
  • 明瞭さ:「技術的な用語(リレーション、プロパティ、ビュー)が定義される前に使用されています。用語集を追加するか、初出時に定義してください。」
  • 完全性:「記事ではコレクションが何であるかは説明していますが、フォルダやタグと比べていつ使用するかが説明されていません。」
  • 品質:「トーンは一貫しています。末尾に冗長なセクションが導入部を繰り返しています。削除することを検討してください。」
4
Sarahはフィードバックに基づいて修正します。セクション2を分割し、定義を追加し、「コレクションをいつ使うか」のセクションを追加し、冗長な部分を削除します。
5
再度ドキュメントレビューを実行します。Assistantが問題が解決されたことを確認します。
6
Sarahはコンテンツが明確で完全であることを確認した上で、自信を持って公開します。

制限事項

ドキュメントレビューはフィードバックを提供しますが、変更を直接適用することはありません。提案に基づいてアクションを取るには、FastまたはMaxモデルのExecuteモードに切り替えて、Assistantに推奨された変更を実装するよう依頼してください。Craft Assistantで編集するをご覧ください。 非常に短いドキュメント(200語未満)の場合、ドキュメントレビューの効果は限定的です。素早いタスクには通常のAssistantチャットの方が適しています。

関連記事

Craft Assistantを使う

Assistantの操作方法と会話の始め方を学ぶ

AIモデルの選び方

ドキュメントレビューや他のタスクに適したモデルを選ぶ

Craft Assistantで編集する

Executeモードでレビューの提案を直接適用する

カスタムプロンプト

一貫したフィードバックのための再利用可能なレビュー指示を作成する

使用量と制限

ドキュメントレビューや他の機能のAI使用量を確認する