SHOEISHA iD

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

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

テクニカルライティング作法・外伝

「起承転結はあるんだよ」~ソフトウェア開発者に贈るテクニカルライティングの極意

テクニカルライティング作法・外伝 第2回

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

 テクニカルライティングに役立つ(かもしれない)話をあれこれと書く連載。第2話は、テクニカルライティングにも起承転結は当てはまるんだよというお話です。

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

はじめに

 テクニカルライティングでは「結論(伝えたいこと)を先に書け!」といわれます。私(筆者)もその通りだと思います。それじゃあ、「起承転結」で書いちゃダメなのか? そうじゃないんです。「起承転結」の「結」は「結論」じゃありません。テクニカルライティングでも起承転結が当てはまるパターンは多いんです。

 今回は、起承転結について掘り下げてみましょう。

「結」は「結論」ではなく「まとめ」です
「結」は「結論」じゃないんだよ

対象読者

  • テクニカルな文章を書いている人/書かなきゃいけない人
  • その中でも、とくにソフトウェア開発に関わっている人

 テクニカルライティングの領域は広いですけど、この連載ではソフトウェア開発に関連した文書を主に想定しています。

結論は先に書く

 結論とは、そのドキュメントの最終的な判断や意見のことです。ようするに「もっとも伝えたいこと」ですね。例えば、次のようなものです。

  • 報告書:プロジェクトに採用するプログラミング言語の調査
    「本プロジェクトには◯◯言語が適している」
  • 報告書:バグの調査
    「問題は◯◯にあり、修正には××人日が必要と見込まれる」
  • 記事:新製品紹介
    「◯◯に使うならこれがベストです」
  • 記事:APIの使い方を紹介するブログ
    「◯◯するには、××を使うといいよ!」

 マニュアルや設計書のように結論といえるものがないこともありますし、性能比較記事のように結論を最後まで伏せておきたいこともあります。でも一般的なテクニカルライティングでは、最初の方で結論が分かるように書きます。この記事も、「テクニカルライティングでも起承転結は使える」という結論をすでに提示していますね。

 「結論を先に書いた方がいいよ」とはさんざん言われていますので、記事や書籍を当たってみてください。このサイトでも「実用文で『起承転結』はNG! 伝わりやすいテクニカルライティングを実践する4つのコツ」(2018/11/27)などで解説されています。

起承転結の「結」とは?

 起承転結は最後に「結」が来ます。「『結』って結論のことだよね」と思いがちですが、そうじゃないんです。ちょっと辞書を引いてみましょう。

起承転結(きしょうてんけつ)とは - コトバンク

精選版 日本国語大辞典の解説

漢詩の構成法の一つ。

起は詩意を起こし、承は起句を承(う)けつぎ、転は一転して別境を開き、結は一編全体の意を結合する

古くは「起承転」という。

 「全体の意を結合する」? 「起承転」ともいう? あれあれ、結論っぽくないですね。全体を結合するというんですから、むしろ「まとめ」や「結び」と言った方が近そうです。NHKラジオの高校講座では、そのものズバリ「全体のまとめです」と説明しています(2017年放送、国語総合第45回の「学習メモ」を参照)。

 「結」とは、そこまでの「起承転」をまとめた「結び」。だから、「結」に結論(もっとも伝えたいこと)が書いてあるとは限らないのです。もちろん文芸なら、もっとも伝えたいことが「結」に書いてあっても構いません。起承転結を英語では"introduction, development, turn and conclusion"と訳します。conclusionには「結論」と「結び」の両方の意味がありますから、ピッタリですね。

次のページ
「春眠暁を覚えず」

関連リンク

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

  • X ポスト
  • このエントリーをはてなブックマークに追加
テクニカルライティング作法・外伝 連載記事一覧

もっと読む

この記事の著者

biac(ばいあっく)

HONDA R&Dで自動車の設計をやっていた機械屋さんが、技術の進化スピードに魅かれてプログラマーに。以来30年ほど、より良いコードをどうやったら作れるか、模索の人生。わんくま同盟の勉強会(名古屋)で、よく喋ってたりする。2014/10~2019/6 Microsoft MVP (Windows Devel...

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

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

この記事をシェア

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

おすすめ

アクセスランキング

アクセスランキング

イベント

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

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

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

メールバックナンバー

アクセスランキング

アクセスランキング