ドキュメントレビューの機能
ドキュメントレビューは、複数の観点からドキュメントを検査します: 構成と整理:- 論理的な流れと展開
- 見出しの階層と一貫性
- セクションのバランスとペース配分
- 情報アーキテクチャ
- 文の複雑さと長さ
- 専門用語や技術的な表現の使用
- アイデア間のつながり
- 全体的な読みやすさスコア
- 不足している背景や文脈
- 説明の不足箇所
- 未回答の質問
- 拡充が必要な部分
- トーンの一貫性
- フォーマットの問題
- 冗長性と繰り返し
- 改善の機会
ドキュメントレビューの開始方法
Assistantがドキュメント全体を読み、カテゴリー別に整理された構造化されたフィードバックを提供します。
ドキュメントレビューはすべてのモデルで動作しますが、Maxは特に長文や複雑なドキュメントに対して、最も徹底的で繊細なフィードバックを提供します。素早いチェックには、Fastが深さとスピードのバランスが良い選択です。
ドキュメントレビューと通常のAssistantチャットの違い
| 機能 | ドキュメントレビュー | 通常のAssistantチャット |
|---|---|---|
| 目的 | 構造化されたドキュメントフィードバック | 自由な会話とタスク |
| 範囲 | ドキュメント全体の分析 | 特定の質問に回答 |
| 出力形式 | フィードバックカテゴリー別に整理 | 会話形式の応答 |
| 分析の深さ | 包括的、多次元的 | 特定の質問にフォーカス |
| 最適な用途 | 品質チェック、公開前レビュー | 簡単な編集、要約、コンテンツに関する質問 |
| フォローアップ | 明確化のための質問が可能 | 継続的な会話 |
| クレジット使用量 | 多い(ドキュメント全体を分析) | クエリの複雑さにより変動 |
ドキュメントレビューの活用場面
ドキュメントレビューは以下のシナリオで特に有効です:外部共有前
プレゼンテーション、提案書、クライアント向けドキュメントを送付する前にレビューし、構造的な問題、不明瞭なセクション、不足している文脈を発見しましょう。品質保証
重要なドキュメント、チームWiki、ナレッジベース記事に対して定期的なレビューを実施し、長期にわたって高品質と一貫性を維持しましょう。コンテンツの改善
ブログ記事、レポート、長文コンテンツに対する実用的な提案を得ましょう。Assistantは、拡充、簡略化、再構成が必要な箇所を特定できます。コラボレーションの準備
チームメンバーと共有する前に、ドキュメントが明確で、完全で、整理されていることを確認しましょう。これによりやり取りが減り、コラボレーションの効率が向上します。学習とスキル向上
レビューを活用して、自分の文章のパターンを理解しましょう。繰り返し発生する明確さの問題、構造的な傾向、一貫して改善が必要な箇所を把握できます。ドキュメントレビューは複数回実行できます。フィードバックに基づいて変更を加え、再度レビューを実行して問題が解決されたかを確認しましょう。この反復的なアプローチにより、効果的な方法を学び、コンテンツを段階的に改善できます。
フィードバックの理解
ドキュメントレビューのフィードバックは、明確なカテゴリーに整理されています。その解釈と活用方法を説明します:構成に関するフィードバック
わかること: コンテンツの流れの良し悪し、セクションのバランス、情報アーキテクチャが適切かどうか。 フィードバック例:- 「導入部がドキュメントの残りの部分に対して長すぎます」
- 「セクション3はセクション2からの明確なつながりがありません」
- 「見出しの階層がH2からH4に飛んでいます」
明確さに関するフィードバック
わかること: 文章が理解しやすいかどうか、文が複雑すぎないか、読者が混乱しそうな箇所はどこか。 フィードバック例:- 「この段落は受動態が多用されており、わかりにくくなっています」
- 「最初のセクションの専門用語が、専門外の読者を混乱させる可能性があります」
- 「文の長さが平均35語です。短い文に分割することを検討してください」
完成度に関するフィードバック
わかること: コンテンツのギャップ – 不足している文脈、未回答の質問、より詳細が必要な箇所。 フィードバック例:- 「ドキュメントで『新しいプロセス』に言及していますが、定義されていません」
- 「ステップ2と3は、導入部でカバーされていない事前知識を前提としています」
- 「結論や次のステップが提供されていません」
品質に関するフィードバック
わかること: トーンの一貫性、フォーマットの問題、コンテンツを磨く機会。 フィードバック例:- 「セクション間でトーンがフォーマルからカジュアルに変わっています」
- 「箇条書きのフォーマットが一貫していません(ピリオドで終わるものとそうでないものがあります)」
- 「この概念が2回説明されています。統合することを検討してください」
クレジット使用量
ドキュメントレビューは、ドキュメントの長さと複雑さに基づいてAIクレジットを消費します:| ドキュメントの長さ | おおよそのクレジットコスト(Fast) | おおよそのクレジットコスト(Max) |
|---|---|---|
| 短い(< 500語) | ~0.5クレジット | ~1-2クレジット |
| 中程度(500-2000語) | ~1-2クレジット | ~3-5クレジット |
| 長い(2000-5000語) | ~2-4クレジット | ~6-10クレジット |
| 非常に長い(5000語以上) | ~5+クレジット | ~12+クレジット |
これらは一般的なドキュメントに基づく推定値です。実際の使用量はドキュメントの構造、フォーマットの複雑さ、選択したモデルによって異なります。Assistantメニューでクレジット残高を確認してください。
より良いレビューのためのヒント
1. まずドキュメントを準備する レビューを実行する前に、ドキュメントがある程度完成していることを確認しましょう。Assistantは、粗いアウトラインよりも完成した下書きに対して、より良いフィードバックを提供します。 2. 対象読者を指定する フォローアップのプロンプトで、ドキュメントの対象者をAssistantに伝えましょう:- 「これは製品に精通した技術チーム向けです」
- 「読者は技術に詳しくないステークホルダーです」
- 「Craftを使ったことがない新規ユーザー向けに書かれています」
- 「最初に修正すべき3つの問題はどれですか?」
- 「最も重要な構造的問題は何ですか?」
- 「明確さの問題だけに集中してください」
- 「トーンの一貫性についてレビューしてください」
- 「完成度と不足している文脈だけをチェックしてください」
- 「初心者向けの構造として適切かどうかに焦点を当ててください」
- On-device: ドキュメントレビューには推奨されません(コンテキストが限られます)
- Core: 短いドキュメントの簡単な構造チェック
- Fast: ほとんどのレビューに適したバランス(500-2000語)
- Max: 長く複雑なドキュメントや、最も徹底的なフィードバックが必要な場合に最適
例:ブログ記事の公開前
SarahはCraftのCollectionsの使い方についてブログ記事を書きました。公開前に、明確で完成度が高いかを確認したいと思います。Assistantがドキュメントを分析し、フィードバックを提供します:
- 構成: 「導入部は良いですが、セクション2はセクション3と4を合わせた長さの2倍です。2つに分割することを検討してください。」
- 明確さ: 「いくつかの専門用語(リレーション、プロパティ、ビュー)が定義される前に使用されています。用語集を追加するか、最初の使用時に定義してください。」
- 完成度: 「記事ではCollectionsが何かは説明していますが、フォルダーやタグと比べていつ使うべきかをカバーしていません。」
- 品質: 「トーンは一貫しています。末尾の冗長なセクションが導入部を繰り返しています。削除を検討してください。」
制限事項
ドキュメントレビューはフィードバックを提供しますが、変更を直接適用することはありません。提案を実行するには、FastまたはMaxモデルの実行モードに切り替え、Assistantに推奨された変更の実装を依頼してください。Craft Assistantでの編集をご覧ください。 非常に短いドキュメント(200語未満)の場合、ドキュメントレビューはあまり価値を提供できない場合があります。簡単なタスクには通常のAssistantチャットの方が適切です。関連記事
Craft Assistantの使い方
Assistantの使い方と会話の始め方を学ぶ
AIモデルの選択
ドキュメントレビューやその他のタスクに適したモデルを選ぶ
Craft Assistantでの編集
実行モードでレビューの提案を直接適用する
カスタムプロンプト
一貫したフィードバックのための再利用可能なレビュー指示を作成する
クレジット
ドキュメントレビューやその他の機能のクレジット使用量を理解する