SHOEISHA iD

※旧SEメンバーシップ会員の方は、同じ登録情報(メールアドレス&パスワード)でログインいただけます

CodeZine編集部では、現場で活躍するデベロッパーをスターにするためのカンファレンス「Developers Summit」や、エンジニアの生きざまをブーストするためのイベント「Developers Boost」など、さまざまなカンファレンスを企画・運営しています。

エンジニアのためのドキュメントライティング術

技術者向けドキュメント、書き方のコツは? ドキュメントを書き始める際の具体的な方法を伝授

エンジニアのためのドキュメントライティング術 第2回

  • X ポスト
  • このエントリーをはてなブックマークに追加

生成AIとドキュメントライティング

 最後に、業務に不可欠な存在となりつつある生成AIとドキュメントライティングとの関係について言及します。

 ドキュメントは「誰かの課題を解決するため」に作成されます。課題が解決されるのであれば、その内容は人が書いていようと、生成AIによって作り出されていようと、どちらでも構いません。他の業務と同じように、ドキュメントライティングでも生成AIは高い効果を発揮します。

 ここでは、生成AIの具体的な利用例を3つ紹介します。

初稿作成

 生成AIを活用することで、初稿作成が容易になります。執筆の土台となるアウトラインの作成や、トピックの肉付けに活用可能です。

観点の抜け漏れ確認

 前述した3Cのレビュー観点のみならず、「こんな観点やユースケースがある」といった視点を、多角的に提案してくれるのも大きな利点です。

校正の自動化

 書き手は「これぐらいはわかるだろう」と無意識に難しい文章を書いてしまうことがあります。読み手のペルソナを生成AIに与えた上で、「この読み手が理解しやすい文章になるように、改善点を提案してください」といったプロンプトを用いてもよいでしょう。

 ここまで、生成AIの活用方法を述べてきました。どれだけAIを活用して良いコンテンツを作成したとしても、そのドキュメントに責務を持っているのは人間です。ドキュメントに誤りが含まれていたとしても、「これは生成AIが作ったものだから」というのは言い訳になりません。もちろん、生成AIの技術進化により誤りが解消される可能性もありますが、現時点ではまだ人の目でしっかり確認していきましょう。

まとめ

 本記事では、フェーズ2(作成フェーズ)とフェーズ3(運用フェーズ)、そして生成AIを活用したドキュメントライティングについて解説しました。

 ドキュメントライティングは、開発者がスキルとして身に付けると長期的に大きな効果をもたらす「レバレッジの高い」能力です。生成AIを含めた豊富な手段を活用しつつ、「読み手にどんな価値を届けたいか」を軸に試行錯誤を続けてみてください。きっとあなたのチームや組織を、より円滑にスケールさせる原動力となるでしょう。

参考資料

この記事は参考になりましたか?

  • X ポスト
  • このエントリーをはてなブックマークに追加
エンジニアのためのドキュメントライティング術連載記事一覧
この記事の著者

岩瀬 義昌(イワセ ヨシマサ)

 大手通信事業者にて、大規模IP電話システムの開発、内製、アジャイル開発、人事などの業務に従事後、現在はGenerative AI Project の Leaderを務める。『エンジニアのためのドキュメントライティング』『エレガントパズル エンジニアのマネジメントという難問にあなたはどう立ち向かうのか』『エンジニアリングが好きな私たちのためのエンジニアリングマネジャー入門』を翻訳。エンジニアに人気のポッドキ...

※プロフィールは、執筆時点、または直近の記事の寄稿時点での内容です

この記事は参考になりましたか?

この記事をシェア

  • X ポスト
  • このエントリーをはてなブックマークに追加
CodeZine(コードジン)
https://codezine.jp/article/detail/17977 2025/01/29 11:00

おすすめ

アクセスランキング

アクセスランキング

イベント

CodeZine編集部では、現場で活躍するデベロッパーをスターにするためのカンファレンス「Developers Summit」や、エンジニアの生きざまをブーストするためのイベント「Developers Boost」など、さまざまなカンファレンスを企画・運営しています。

新規会員登録無料のご案内

  • ・全ての過去記事が閲覧できます
  • ・会員限定メルマガを受信できます

メールバックナンバー

アクセスランキング

アクセスランキング