その他

ドキュメント作成について(ChatGPT編)

この記事は約3分で読めます。

はじめに

以前、以下の記事を作成したのですが、今回はその続編になります。
ドキュメント作成について

ドキュメント作成をChaGPTなどのAIを用いて作成する際、どのようなことを意識すれば良いのか
記載していこうと思います。

ChatGPTの欠点

まずChatGPTの欠点を記載していこうと思います。
大きく2つございます。

まだ世の中に出回っていないことは書けない

例えば以下のようなことは書けないです。

  • 未来のこと
  • 未公開のプロダクトに関する情報
    (インターネットなどで公開された情報をもとに学習しているから)

正確にいうと、ChatGPTは書けませんと言わずにもっともらしいことを回答します。
そして、当然ながらその回答には間違いを多く含まれます。

このもっともらしい嘘をつくChatGPTの特性のことをハルシネーションと呼びます。

生成する文章の品質が現地点ではまだ良くない

ChatGPTが出す日本語の文章は英語と比較して劣ると言われています。
例えば、説明が回りくどかったり分かりづらいことがあります。

ChatGPTの欠点を補うための対策

次にその欠点を補うための対策を記載していこうと思います。
大きく2つございます。

ドキュメントで伝えたいことをまとめて、ChatGPTに伝える。

まず書くために必要な情報をChatGPTに伝えてあげる必要があります。
情報をドキュメントにする作業をChatGPTに手伝ってもらうような感じです。

ただし、社外秘の情報を伝えることは注意が必要です。
(入力した情報がAIの学習に利用されるからです。)

ChatGPTの出力はあくまで下書きとして扱い、自分で手直しする。

ドキュメントを書くときにつまずきがちなのが、白紙の状態からの最初の第一歩でしょう。
なので、まずChatGPTに下書きを作成してもらい、それを手直しすることで、ドキュメントの内容を考えやすくなるのではないでしょうか。

ChatGPTが活躍するところ

次にChatGPTが活躍するところについて記載していこうと思います。

ドキュメントの構成

ドキュメントの構成を組むことは文章以上に大切です。
なぜならば、構成をうまく組めばどこに何が書いているか分かりやすく整理されるからです。
もちろん、ChatGPTが出す構成案が適切かどうか評価する必要はありますが
一から自分で考えるより、たたき台をもとに考えた方が思考が進みやすいと思います。

ドキュメントの下書き

先述にも述べましたが、ドキュメントの下書きをChatGPTにしてもらうこともできます。
(構成案と同様で適切かどうか評価する事は必要です。)

下書きで重要なことは
盛り込みたい情報をできるだけ具体的に指定する事です。

なぜならば、具体的に記載すれば品質の高い内容を
ChatGPTが出力してくれるからです。

文章の校正

自分が書いた文章をChatGPTに校正してもらうこともできます。

校正とは、一度書いた文章に対して
わかりづらい、あるいは本体言いたいことと別の意味にとれる文書を改善したり
誤字や脱字を修正したりすることです。

自分が書いた文章の改善点はなかなか気づけないことが多いので
(その文章で何が言いたいのか自分が知っているため)
レビュアー的な役割をChatGPTに担ってもらいましょう。

さいごに

ChatGPTを用いる際、今まで記載してきたことを意識していただければ
ドキュメントの作成に掛かる時間を飛躍的に短縮できる可能性がございますので
皆様の効率的な業務遂行にお役立ていただければ幸いです。

参考文献


エンジニアが一生困らない ドキュメント作成の基本