SHOEISHA iD

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

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

生成AIを活用!超時短テクニカルライティングのススメ

【超時短テクニカルライティング】生成AIを活用してドキュメントを書く流れを掴もう!

生成AIを活用!超時短テクニカルライティングのススメ 第1回

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

この記事でよく登場する用語について

 具体的な手法の話に行く前に、「生成AI界隈の用語」や「テクニカルライティング」にあまり詳しくない方もいらっしゃると思いますので、まず初めにこの記事でよく登場する用語について説明しておきましょう。

生成AIとは?

 「生成AI」は、一般には文章やイラスト、写真のようなものを生成するAI全般のことを指します。ただし、この記事では特に「自然言語処理技術を活用し、大量のテキストデータを基に自動で文章を生成するツール」に限定しています。

 「(この記事における)生成AI」を利用するもっとも有名なサービスはChatGPTでしょう。ChatGPTのような生成AIは、主にゼロからのテキスト生成や、すでにある文章の修正を行うことが得意なため、私たちがドキュメントを作成するシーンで活躍します。

 生成AIを利用すると、初期段階の原稿を短時間で作成できます。特に、定型的なフォーマットや構成が決まっているドキュメントを作成するときは、生成AIに基礎部分を任せ、人間はより高度で専門的な内容に集中できるでしょう。

 技術的な用語を正確に使用することや、過去の文書との一貫性については生成AIがサポートしてくれるため、ミスの削減やレビューサイクルの短縮が可能となり、全体的に効率が向上することが期待できます。

生成AIを使うときの注意点

 機密情報に関するコンテンツを書く場合は、所属する団体や企業が定めた生成AIの利用ルールやガイドラインに従ってください。対象の業務で生成AIの利用を許されていない場合は、残念ながらこの記事で紹介する手法は使えません。

  ソラコムでは「Generative AI 利用ガイドライン」[1]が整備されており、「未公開の技術情報(発明等につながらないもの)」については、別途定められた条件を満たす生成AI (ChatGPTは満たしています)に入力することを許可されています。このようなガイドラインが整備されていない場合は、ガイドラインの整備から始めていただく必要があるかもしれません。

[1] 少し古い記事ですが、ガイドラインの策定については次の記事も参考になるかもしれません。現在はさらにブラッシュアップされたガイドラインが運用されています。

プロンプトとは?

 「プロンプト」は、生成AIに対して与える指示文のことです。生成AIはこの指示(プロンプト)に基づいて文章を生成します。プロンプトの質は、生成AIが生成する文章の質に直結します。

 この記事で紹介するプロンプトは、テクニカルライティングで生成AIを使用する際に便利なプロンプトとも言えるでしょう。そこには、実はテクニカルライティングで気を付けるポイントがふんだんに入っています。

 たとえば、初期段階のドラフトを作成するときのプロンプトでは、以下のような情報を具体的に含めると、生成AIが的確な文書を生成しやすくなるでしょう。

  • 書きたい内容の概要
  • 想定する読者層。例:「IT技術に詳しくない読者に向けて、ネットワーク設定の基本的な説明をしてください」
  • 専門用語の使いかた
  • 文体の要望。文体については、言葉で仔細に説明するのではなく、好みの文体を利用した文章を例として提供し、それを真似させるように指示するといいでしょう。

テクニカルライティングとは?

 「テクニカルライティング」は、技術や製品に関する正確かつ分かりやすい情報を文書化する際に使われる技術です。

 たとえば、社外向けのドキュメントを例に挙げると、ソフトウェアの操作マニュアルや、製品の使用ガイドを書くときにテクニカルライティングの技術が使われます。私は、ユーザーサポートのためのドキュメントが充実していると、製品の価値がより高まると考えており、わかりやすさを実現するためのテクニカルライティングの技術は重要と考えています。

 もちろん社内向けのドキュメントにもテクニカルライティングの技術を使えます。仕様書はイメージしやすいと思いますが、議事録や日報を書く際にもこの技術は使えるでしょう。

 従来、テクニカルライティングは専門的な知識を持った人が、0~100まですべて手作業で書いてきました。最近では、生成AIを利用することで、このプロセスが大幅に効率化できる可能性が見えてきています。

 テクニカルライティングの最終目標は、単に読みやすいドキュメントを書くことではなく、筆者が意図したとおりに読者に情報を伝えることです。生成AIを活用することで、この目標を達成しつつ、プロセスを効率化していきましょう。

次のページ
超時短テクニカルライティングの流れ

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

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

CodeZine編集部(コードジンヘンシュウブ)

CodeZineは、株式会社翔泳社が運営するソフトウェア開発者向けのWebメディアです。「デベロッパーの成長と課題解決に貢献するメディア」をコンセプトに、現場で役立つ最新情報を日々お届けします。

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

株式会社ソラコム(ソラコム)

ソラコムでは、アイディアやパッションを持つあらゆる人がIoTテクノロジーを活用できるようにする「IoTの民主化」をミッションに、IoTプラットフォームSORACOMを提供しています。デバイス通販サイト SORACOM IoT ストアでは、実績あるIoTデバイスを1個から提供、必要な機材一式と手順の書かれた<...

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

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

この記事をシェア

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

おすすめ

アクセスランキング

アクセスランキング

イベント

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

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

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

メールバックナンバー

アクセスランキング

アクセスランキング