AI+ 技術文書作成
常に明確なドキュメンテーションを
ドキュメントは明確に。読者には的確に。バックログはゼロに。
ドキュメンテーションのバックログは増える一方です。何を書くべきかはわかっています。時間がかかるのは、技術的な知識を正確で明確な文章にする工程です。本書は、CLEAR Framework、38のプロンプトを収めたTechnical Writing Prompt Toolkit、そしてAIを活用してドキュメントを下書きし、読者層別に書き分け、維持管理するための体系的なアプローチを、技術文書ライターとエンジニアの皆様にお届けします。自社の本番システムのドキュメントを自ら書いている、AIエンジニアリング企業による一冊です。
- すぐに使える、実証済みのプロンプト38個：ユーザーガイド、APIリファレンス、標準作業手順書（SOP）、技術仕様書、トラブルシューティング資料、リリースノート、ランブック
- CLEAR Framework：完全性、階層性、正確性、可読性、更新可能性の5つの観点
- 読者層別に書き分ける手法：ひとつの情報源から、開発者・管理者・エンドユーザーのそれぞれに届く文書を作成できます
- ドキュメンテーション・バックログの進め方：終わりの見えないToDoリストを、30日間のスプリントに変えます
- 30日間の実践計画：技術文書ライター、自分でドキュメントを書く開発者、プロダクトマネージャー、DevOpsエンジニア、仕様書を書くエンジニアのために設計されています
技術文書の作成が業務の中心、または重要な一部であるすべての方：プロの技術文書ライター、自分でドキュメントを書くソフトウェア開発者やエンジニア、ユーザー向けコンテンツに責任を持つプロダクトマネージャー、ランブックやテスト文書を管理するDevOpsエンジニアやQAエンジニア、仕様書・標準作業手順書（SOP）・プロジェクト文書を書くエンジニアや建設分野の専門職、社内ナレッジベースや業務手順書を管理するIT管理者の方々。分野を横断する設計です。ドキュメンテーションの技術は、ソフトウェア、エンジニアリング、製造、医療、金融、行政のいずれにも等しく当てはまります。
その他の対象：ドキュメンテーションの基準を定めるコンテンツストラテジストや情報アーキテクト、専任の技術文書ライターがいない中で文書品質に責任を持つテクノロジーチームのリーダー、規制産業で規制当局への提出書類、安全マニュアル、監査文書の作成に携わるエンジニアや科学者の方々。
- 実際の文書作成業務にAI Opportunity Matrixを適用し、AIに任せる・補強する・AIの関与から守るべき、投資対効果の高いタスクを特定する
- 構造化されたソース資料から、AIによる骨組みづくりを活用して、ユーザーガイド、APIリファレンス、標準作業手順書（SOP）、技術仕様書などの初稿を作成する
- ひとつの情報源から、開発者、管理者、エンドユーザーのそれぞれに役立つ、読者層別のコンテンツを書く
- AIが生成した技術文書を、完全性、階層性、正確性、可読性、更新可能性の観点からCLEAR Frameworkで評価する
- トピック型の執筆原則を用いて、モジュール型のドキュメンテーション一式を設計・維持する
- 安全性が極めて重要な文書や規制対象の文書において、AIの利用を適切に管理する
- スキルチェック
- 技術文書作成は、AIに対応していますか？
- 第1章
- 今、技術文書作成におけるAI
- 第2章
- 技術文書ライターのAIワークフロー
- 第3章
- 異なる読者に向けて書く
- 第4章
- ソース資料からの初稿作成
- 第5章
- APIと開発者向けドキュメント
- 第6章
- 正確性・明確性・一貫性のための編集
- 第7章
- 構造化された文書作成とモジュール型ドキュメンテーション
- 第8章
- 生きているドキュメントの維持管理
- 第9章
- 安全性・コンプライアンス・高リスク文書の取り扱い
- 第10章
- 30日間のドキュメンテーション計画
- 巻末資料
- スキルサマリー・推奨書籍・用語集・ツールリファレンス
AIエンジニアリング企業が開発した一冊——正確さが求められるドキュメントを書き、その文書が実際に使われなければならない技術文書ライターのために。