SHOEISHA iD

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

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

Developers Summit 2024 セッションレポート

生成AIの使う「本物の英語」でマニュアルを作成──LLM時代の外国語テクニカルライティングとは

【16-D-1】生成AIで立ち向かうIT英語ライティング

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

ドキュメントの特性や英語表現についての理解も不可欠

 ここからはいよいよ実践編だ。先ほど説明があったとおり、良質なアウトプットを得るにはドキュメントタイプの知識が不可欠となる。これを踏まえて、話題はマニュアルというドキュメントタイプの説明へと移った。

 「マニュアルとは、ソフトウェアやデバイスの使用方法や操作手順を説明したものだ。ITエンジニアであれば、マニュアルを丸々一冊書くことはないにしても、ちょっとした操作手順を英語で書くケースはあるだろう。ここからの内容は、そうした方々にとっても有益なはずだ」(西野氏)。

 例として西野氏は、Google Apps Scriptのマニュアルのうち、ウェブアプリのデプロイをテストする操作手順を説明している部分を示した。このマニュアルには一般的に見られる主要素として、(1)見出し(2)導入文(3)手順の導入文(4)手順、の4点が含まれている。

 マニュアルによっては目次や注意書き、補足なども書かれることがあるが、典型的なマニュアルであれば上記(1)〜(4)の主要素で構成される文章構造を取るケースが多い。生成AIで文章全体を生成する場合は、こうした文章構造を備えているかの確認が必須だ。

Railroad図を使用して示された、一般的なマニュアルにおける文章構造
Railroad図を使用して示された、一般的なマニュアルにおける文章構造

 文章中の表現においては、以下7つの特徴がある。

  1. ⾒出しはタスク型なら動詞原形
  2. 手順は番号リスト
  3. 指示文は命令形
  4. 指示文では場所、条件、目的が先
  5. 指⽰⽂でUI要素はボールド、連続操作は「>」
  6. 読者はyou、読者の所有物はyour
  7. 注意書きはNote、Caution、Warningなど

 1.はユーザーに何らかの操作をしてもらう「タスク型」マニュアルの場合、見出しが動詞原型で書かれているもの。西野氏は「動詞を最初に置くのは、したい操作が見つけやすくなるのが理由の一つだと考えられている」としたうえで、「to不定詞やing形で始める書き方もあるが、最近の大手IT企業ではシンプルに原型を使うケースが多い」と示した。

 2.の番号リストには、項目の先頭に中黒を置く中黒リストと、先頭に番号を置く番号リストの2種類が存在する。一般的に番号リストは順序が関係ある項目を並べるのに使い、中黒リストは順不同の項目に対して用いる。

 3.は手順のステップなどに書かれる指示文における特徴で、シンプルに命令形を使うものだ。「日本語では、『〜してください』といった丁寧な表現を使うのでPleaseを付けたくなるが、英語では一般的にPleaseなしの命令形だ」と西野氏は話す。これが「日本語的な発想」から脱却するために生成AIを用いるメリットの具体的な事例だ。

 4.はAt、Next to、Underといった場所を表す言葉や、指示文中の「to test」のような目的を表す言葉は先に置かれるものだ。西野氏は「条件を先に置くことでユーザーがいきなり削除などの危険な操作をしてしまうことを防げる。また、目的を先に置くことで何のための操作かが分かりやすくなる」と理由を説明した。

 5.は、ボタンなどの名前はすべてボールドとしたうえで、たとえば「deployをクリックした後にtest deploymentsをクリックする」といった連続操作の手順を表す際には、矢印の代わりに大なり記号(「>」)を使用するテクニックだ。

AIで作った文書であっても、ユーザーフレンドリーな書式であるべき
AIで作った文書であっても、ユーザーフレンドリーな書式であるべき(英文はGoogle Apps Scriptのマニュアル)

 6.は、読者が使うブラウザーはyour browser、読者が使うwebアプリはyour web appのような形で統一するものだ。「youを使うことで、相手に直接語りかける雰囲気になる」と西野氏は説明する。

 7.の注意書きは文章構造の主要素には入っていないものの、必要に応じて置かれるもので、使われる表現は決まり文句となっている。西野氏はGoogleの開発者向けスタイルガイドを例にとり、「noteは有益となる補足情報やコツ、cautionは注意して進むよう読者に知らせ、warningはcautionよりも強く注意喚起する」と紹介した。

次のページ
細かい部分は人の手でチェック&修正

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

  • X ポスト
  • このエントリーをはてなブックマークに追加
Developers Summit 2024 セッションレポート連載記事一覧

もっと読む

この記事の著者

山出 高士(ヤマデ タカシ)

雑誌や広告写真で活動。東京書籍刊「くらべるシリーズ」でも写真を担当。

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

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

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

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

中島 佑馬(ナカシマ ユウマ)

 立命館大学卒業後、日刊工業新聞社にて経済記者として勤務。その後テクニカルライターを経て、2021年にフリーランスライターとして独立。Webメディアを中心に活動しており、広くビジネス領域での取材記事やニュース記事、SEO記事の作成などを行う。

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

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

この記事をシェア

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

おすすめ

アクセスランキング

アクセスランキング

イベント

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

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

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

メールバックナンバー

アクセスランキング

アクセスランキング