4-3 1章以降を執筆する

1章以降の基本フォーマット

1章以降の基本フォーマットを下記に示します。

項目を一つずつ説明します。

節のタイトルには、目次を作成した際の節のタイトルを書いてください。

何を実装するのか具体的なゴールがないと、指示通り実装したとしても、「本当にこれで合っているのだろうか」と不安になります。また、何を実装するのか実装する前に理解していないと、今書いているコードが作りたい機能のどこに役立つのか分かりません。

なので、実装する前に今から何を実装するのかゴールを明確にする必要があります。ゴールで記載することは以下の2つです。

上記の2つを実装する前に認識していると、学習者は実装するのかイメージができゴールに向かって学習できます。

実際に目標物(ゴール)がある場合の例を下記に示します。どのような見た目になるか画像があり、どういった情報が必要か記載することで、何を実装するかイメージがしやすくなります。

節でどういったことをするのか、ゴールを記載したらそのゴールを達成するための流れを記載してください。ゴールとその流れを記載することで、学習者は全体像を掴みやすくなります。また執筆する際も節の構成を整えやすくなります。

動作確認ができる箇所は適宜GIF画像や画像を使って実装イメージを表示してください。教材の構成としては細かく動作確認ができる方が、仮に学習中つまづいてもどこで間違えたのかスコープが小さいほど誤りを見つけやすいです。

また動作確認する際に、特定のリンクにアクセスする必要がある場合は、どのリンクにアクセスすれば動作確認ができるかリンクも追加してください。

※ GIF画像をとるツールとしては Gyazo がおすすめです。

****

各節の最後には簡単なコメントや一言を入れてください。仮に最後の一言がなく、コードや画像で節が終了している場合、読み手は「まだ続きがあるのでは？」と考えることが分かりました。なので節が終わったことを明示的に示すことで読み手は安心して次の節に進むことができます。

教材の最後となる節には、最後に教材全体を簡単に振り返るコメントを入れてください。

特に教材を通して作成したサンプルアプリや、教材の中でも特に重要なキーワードや技術についての振り返りが書かれていると良いです。読み手は振り返りコメントで「この技術を身につけることができたんだ」と教材を終えた後の達成感をより感じることができます。

****

1章以降のフォーマットに関しては、Githubを使って簡単に導入できるリポジトリをご用意しています。以下のリポジトリのREADME.mdを参考に導入してください。

最終更新 2 年前

役に立ちましたか？