SHOEISHA iD

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

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

先輩ライターに訊く、技術文書執筆のアレコレ

先輩ライターに訊く、技術文書執筆のアレコレ(1)
~花井志生(宇野るいも)さん

技術文書執筆の現場(1)

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

 本連載では、書籍や雑誌といった商用ベースでの技術文書を執筆したことがあるライターの体験談をリレー形式で紹介します。普段、なかなか突っ込んで聞く機会の少ない生の声をお伝えしますので、今後技術文書を執筆してみたいと考えている方の参考になれば幸いです。第一回は発起人の私、花井志生(宇野るいも)です。

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

1 はじめに

 今回から何回かに分けて、執筆経験談を連載で始めていきたいと考えています。以前に比べると、自分の文書を公開することはずっと簡単に行え、また幅広くさまざまな方法から選択できるようになりました。本記事のようなWeb系の連載記事に投稿するのはもちろん、自分専用のサイトを作って文章を公開したり、あるいはブログサービスに申し込んでも良いですし、twitterに短文を連続投稿することでまとまった記事とすることさえ可能です。しかし記事を公開する敷居が下がったとはいえ、その文書を人に読んでもらうためには、これまで同様、依然として十分な配慮が要求されます。そこで本連載では毎回、執筆経験のある著者の方に登場いただいて執筆にあたってどんなことに注意しているのか、どんな工夫をされているのかを紹介していただこうと思っています。

1.1 企画の背景

 本題に入る前に、私がなぜこんなことを始めたのかを先に、お話ししておきましょう。私はこれまで縁あって何冊かの書籍、雑誌を執筆してきました。そんな中、会社から「自分で書くだけでなく、他の社員にもそのスキルを広めるように」という話が来たのが今年の頭です。私が勤務する会社には社内勉強会というのがあって、年に2回ほど社員がボランティアベースで集って研究を行い、その成果を発表する催しがあります。私はそこでリーダとして執筆に関する勉強会を立ち上げなければならなくなりました。

1.1.1 社内勉強会で行ったこと

 執筆経験があるとはいえ、私自身、何か特別な才能があるわけでもなく、1人で運営するのは荷が重すぎます。そこで個人的に知っている執筆経験のある社員に事前に声をかけて勉強会に入ってくれるようにお願いしつつ、一般参加社員を募集しました。期せずして20人近い社員が集り、不安をかかえたリーダのもと活動は開始されました。具体的には、月1ベースで会合を行い以下のような作業を繰り返していきました。

  • 執筆練習とレビュー

 メンバに自分の好きなテーマを1つ選んでもらい、20ページほどの技術解説文書を2週間で書いてもらいます。次の2週間で、他のメンバに内容の添削をしてもらいます。この添削は文章の内容そのものではなく、全体の構成とか、理解しやすいかという観点で見てもらいます。そして月に1度の会合でディスカッションを行います。

  • 執筆経験談

 メンバの中で執筆経験のある人に、執筆の経験を話してもらいました。特に何が大変か、どんなツールを使っているのかを始めとして、原稿料の話まで、ざっくばらんに語ってもらいました。

1.1.2 アウトプットの公開から話が膨らんだ執筆体験談の共有

 初めての試みだったため、いろいろと予想外なことがありました。当初練習用として考えていたメンバに書いてもらった解説文書が思いのほか面白かったというのもその一つです。このままこの文書を捨ててしまうのはもったいないと感じられたため、個人的に知っている編集者さんを通じて3社の出版社に雑誌やWeb記事にできないか打診してみました。結果として1つの文書が1社でWeb記事として正式採用になり、残りの記事は現在選考中ですが、ほぼ残りの2社のどちらかで採用してもらえそうです。3社目の編集さんとはいろいろと話もはずみ、執筆経験談の方も記事にできないかという流れとなり、今回の連載に至っています。とりあえず現時点で私を含めて社内の4人の執筆経験者には書いてもらう予定ですが、せっかくなので社外の人にも声をかけて、いろいろな人の執筆経験談が聞けたらいいなと思っています。

1.2 この連載で提供したいこと

 技術文書の書き方というと、これまではどちらかと言えば論文などの「読む側もプロ」な文書の書き方に関するものが多かったのではないでしょうか? しかし雑誌やWeb記事に掲載する文書の場合、読み手に分かりやすく噛み砕いて伝えるという技術も重要となります。今回の連載は、そうした文書を執筆した経験のある方からいろいろな経験を語っていただきます。今後技術文書を書いてみようと考えている方の参考になれば幸いです。

次のページ
2 執筆者紹介(共通の質問項目)

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

  • X ポスト
  • このエントリーをはてなブックマークに追加
先輩ライターに訊く、技術文書執筆のアレコレ連載記事一覧

もっと読む

この記事の著者

花井 志生(ペンネーム 宇野るいも)(ハナイ シセイ(ペンネーム ウノルイモ))

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

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

この記事をシェア

  • X ポスト
  • このエントリーをはてなブックマークに追加
CodeZine(コードジン)
https://codezine.jp/article/detail/6165 2011/09/26 14:00

おすすめ

アクセスランキング

アクセスランキング

イベント

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

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

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

メールバックナンバー

アクセスランキング

アクセスランキング