4-1 執筆をはじめる前に

執筆をはじめる前に、執筆する上で意識した方がいいことを説明をしていきます。

執筆する上で意識した方がいいこと

執筆する上で意識した方がいいことは以下の3つになります。

1. 手を動かしながら学べる構成になっているか

2. 教材で達成したい目的を満たしているか

3. 技術的な誤りがないか

1つずつ説明していきます。

1. 手を動かしながら学べる構成になっているか

エンジニアリングを学ぶ上で、テキストを読むだけの説明だと中々頭に入りません。実際に手を動かして初めて知識が定着していきます。なので手を動かしながら学べるような構成にしていただければと思います。

また、手を動かしながら「学べる」構成にするためには、コードを提示するだけでなく、そのコード中に登場する要素(注)について、学習者が理解できるレベルでわかりやすく解説するようにしてください。

注：ここでいう要素とは、例えば特定のフレームワークをテーマとする教材であれば、そのフレームワーク固有のメソッドなどを指しています

こうした解説が無く、アプリを作るためのコマンドやコードを提示されるだけの内容が繰り返し続くと、学習者は作業感、やらされ感をおぼえて、せっかくの教材に対して不満を持つケースがあります。

逆に、ここでの解説によって、現役のエンジニアからわかりやすく、実務でも役立つ知識が得られると、学習者は高い満足感を得ます。ぜひ学習者の目線でわかりやすい解説を心掛けてください。

2. 教材で達成したい目的を満たしているか

教材のテーマを考える際に「**今回執筆する教材が終わったら何ができるようになるか」**ゴールを設定していただいたと思います。執筆する際はこのゴールを達成できるように意識する必要があります。

コツとしては、「目的を達成するために必要なことを羅列する」といいです。何をすればその目的が達成できるのかを思いつく限り羅列し、羅列したことを意識して執筆しましょう。

例えば「【Ruby on Rails 5】Instagram風簡易SNSアプリを作ってみよう！」という教材では以下のように考えました。

例 目的達成に必要なことの洗い出し

この教材を終えたら学習者はどのような状態になっているか

• MVC を理解している状態

• Rails で簡単な機能実装ができるようになる

目的を達成するためには何が必要か？

• MVCを理解している状態

  • MVCの概要を図を使って説明

  • その図を使いながら実装の流れを説明

  • 上記を何度も反復することでMVCの知識を定着

• Rails で簡単な機能実装ができるようになる

  • 本教材でできたRailsのコードや書き方は説明する(Active Record やマイグレーションファイルなど）

3. 技術的な誤りがないか

みなさんは書籍等で学習している際に、内容の誤りを見つけたことはありますでしょうか？

もしそうなった場合、技術理解が浅い学習者は誤った解説の箇所だけに限らず、教材全体として間違った内容を教えられているのではないかと不安になります。

そうはならないように、このあと執筆していく上で、少しでも技術的に怪しいなと思う箇所がございましたら、その技術に精通している知人または先輩等に相談することを強くオススメします。

実際に執筆を進めていただく GitHub のリポジトリに collaborator として知人を招待することも可能ですのでその際は運営に一言ご相談いただけると幸いです。

※ Techpitでは、技術的な観点でのレビューを最小限に押さえ、メインとして日本語的な分かりやすい説明に関するレビューをさせていただきます。