1.md

description
このページを読むのに必要な時間は約1分です。

1章 本ガイドについて

本ガイドでは、Techpit がこれまでに教材を作成してきた知見を踏まえ、プログラミング学習者向けに学習教材の作り方を順序立てて解説しています。

Techpit で評判が高い教材の条件

これまでのTechpitでの教材販売・学習者の評価実績から、評判が高い教材は主に以下3つの条件を満たしていることと考えております。

1. ゴールが明確になっている

何を作るのか具体的なゴールがないと、指示通り教材を進めても、自分が今やっていることがどこで役に立つのかイメージがしにくいです。なので実装する前に今から何をするのか、今していることはどこで役に立つのか明確にすると学習者は何を作るのかイメージができゴールに向かって学習できます。

詳しくは「4-2 1章以降を執筆する」に記載しています。

2. 実装箇所やコマンドの実行箇所を丁寧に記載している

どんなにコードの説明を詳しく書いても、どのファイルに実装するのか記載されていなければ学習者はどこにコードを書けばいいか迷います。またインデントが揃っていなければコードが読みづらいです。そういった細かいところを疎かにしていると分かりづらい教材になってしまいます。なので実装箇所やコマンドの実行箇所など細かいところも意識して教材を作成しましょう。

詳しくは「4-3 実装箇所の説明のフォーマット」「4-4 コマンド実行箇所のフォーマット」に記載しています。

3. 図やスクリーンショットを使って説明している

脳の40%は視覚を処理し、世界人口の65%はビジュアルで学習していると言われています。つまりビジュアルは、以下の効果があります。

• 脳の情報処理を加速化する
• 長く記憶に定着する

なので図を使って説明している教材は分かりやすく評判もいいです。動作確認をする際やFirebaseなどの外部ツールの環境設定等は図を使って説明しましょう。またテキストだけでは伝わりづらい概念も図で解説することが重要になります。

この執筆スタイルガイドでは執筆のポイントを書いています

本スタイルガイドは上記3点を満たす人気の出る教材を作るために必要なポイントを書いていきます。都度情報は更新される予定なので適宜必要に応じて確認してください。