目次

はじめに

諸注意
免責事項
表記関係について
底本について

第1章 原稿を書き始める前の準備

目次を作る
本の中で達成したい目的を整理する
目的を達成するために必要なことを羅列する
羅列した項目を仲間わけし、名前をつける
各項目内で伝わりやすいように順序を入れ替える
目次を書く例~実例をもとに

第2章 本文を書く

最優先事項は書き終わること
執筆時に困った事例とその解決法
文章の記述を進める例

第3章 推敲してより良い原稿を作成する

なぜ原稿の推敲は大切なのか?
推敲するポイント(基礎編)
推敲するポイント(応用編)

第4章 実際の技術同人誌に基づく文章の記述と推敲作業の例

実例1:特定技術の解説を行う文章例
事例2:環境構築時に準備しておくべきことの説明例
事例3:コンフィグの設定を変更するための説明例
事例4:ミドルウェアのコンフィグを記述する方法に関する説明例
事例5:コンフィグのオプションを説明する例
事例6・7:画面の機能を解説する例

おわりに

はじめに

 こんにちは。この本を手に取ったあなたは今、こんなことを考えているのではないでしょうか。

 ・技術同人誌が盛り上がっているらしいので、自分でも書いてみたい

 ・でも文章を書くのは自信がない

 ・たくさん書かないといけないと聞くけれど、どうやって書けばいいのかわからない

 ・思うように文章が書けない

 ・やっぱり文章を書くのは向いていないから、やめておこう

 「やっぱり文章を書くのは向いていないから、やめておこう」?……それは大変もったいないことです。文章の書き方を理解すれば、誰でも文章を書けるようになります。

 「文章の書き方」とは、次のものを指しています。

 ・何を書くか、をどうやって探すか

 ・章の組み立て方

 ・文章の組み立て方

 ・段落の切り方

 ・接続詞の使い方

 ・助詞の使い方

 ・タイトルの付け方

 ・説明するための考え方

 ・推敲のやり方

 ・紙面の作り方

 そのくらいわかっているよ、と思われるかもしれません。しかし、これらのポイントを守らないと、本の品質はガタっと落ちます。読者が「ちょっと読みにくいかも」と感じる本は、「文章の書き方」がよくない場合が多いのです。

 「でも、その文章の書き方がわからないから困ってるんじゃないか!」と思ったでしょう?そんなあなたに向けて、この本を書くことにしました。現時点1で、技術同人誌に特化した「文章の書き方」を解説した本を見つけることができなかったためです。

 「『技術同人誌を書こう! アウトプットのススメ2』という本があるよ!」と思われたかもしれません。しかし、この本は「同人誌即売会へ申し込んで本を出すまでの工程」について書かれた本です。何について書くか、に関しても1章が割かれています。しかし、本のメインコンテンツは表紙の作り方や即売会当日の持ち物についてです。文章の書き方はほぼ解説されていません。何故断言できるのか?私もこの本に「何について書くか?」の章を寄稿しているからです。

 技術文章の書き方について記載した本は存在します。しかし、それらは仕事のための文章や学会発表、商業本を書くことを想定していることが多いのです。

 技術同人誌は他の「書く」ことよりも自由度が高く、かつ誰かが品質をチェックして合格サインを出してくれることがありません。他の人にレビューを依頼すれば、感想やアドバイスをもらえるかもしれません。それを取り入れるかは、あなた自身が決める必要があります。

 判断基準が明確でない場合、意見を取り入れるべきか迷ってしまいます。全部取り入れてしまえば楽でしょう。ただ、これは同人誌なのです。主役はあなた自身であるべきです。

 自分の時間を割いて本を作るのであれば、自分の意見を読者に届けたいですよね。そのためには、「良い」文章を書くことが重要です。「良い」文章の書き方に迷ってしまったときに、この本がお役に立てれば幸いです。

諸注意

 技術同人誌の書き方を説明した本なので、できれば実際の技術同人誌を参考文献にしたいですよね。

 そこで技術同人誌の記述例として、『ログと情報をレッツ・ラ・まぜまぜ!~ELK Stack で作るBI環境~』という本をを引用します。

図1: ログと情報をレッツ・ラ・まぜまぜ!~ELK Stack で作るBI環境~

 そして、もう一冊の『Elastic Stackで作るBI環境 誰でもできるデータ分析入門』は、『ログと情報をレッツ・ラ・まぜまぜ!~ELK Stack で作るBI環境~』の内容を修正し、商業出版した本です。商業出版をするにあたり、技術同人誌の内容を大幅に書き直しています。

図2: Elastic Stackで作るBI環境 誰でもできるデータ分析入門

 引用する内容の中にはElastic Stackの機能に関する説明文があります。ですが、この本を読み進める上ではElastic Stackに関する内容の理解は不要です。実際の技術同人誌の作例を元に、より良い文章表現について考えることが目的だからです。

 また、この本では商業出版の方法・印税については言及しません。

 この本では「より伝わりやすい技術同人誌を書くためにやった方が良いこと」をいくつか紹介しますが、取り入れるかどうかはあなた次第です。なぜならば「同人誌」は個人が自由に作成することが大原則だからです。この本で紹介する表現とあなたが「良い!」と考える表現がぶつかった場合は、あなたの表現を優先するべきです。

 好きなことを好きなように表現するのが「同人誌」の醍醐味なのですから。

免責事項

 本書に記載された内容は、情報の提供のみを目的としています。したがって、本書を用いた開発、製作、運用は、必ずご自身の責任と判断によって行ってください。これらの情報による開発、製作、運用の結果について、著者はいかなる責任も負いません。

表記関係について

 本書に記載されている会社名、製品名などは、一般に各社の登録商標または商標、商品名です。会社名、製品名については、本文中では©、®、™マークなどは表示していません。

底本について

 本書籍は、技術系同人誌即売会「技術書典6」で頒布されたものを底本としています。

試し読みはここまでです。
この続きは、製品版でお楽しみください。