4章 執筆スタイルガイド

4章では執筆スタイルガイドを記載しています。執筆スタイルガイドは今までTechpitを1年半運用してきて学習者の方や技術書を執筆している方の意見を元に作成しており、執筆スタイルガイドに沿えば確実に分かりやすい教材を作成することができます。

教材が分かりやすければ、学習者の満足度が上がり、満足度が高ければ口コミで購入件数が増えるので、4章の執筆スタイルガイドに沿って教材を作成してください。

なお執筆スタイルガイドに沿っていない箇所があればレビューで指摘する可能性が高いのでよろしくお願いいたします。

4-0 GitHubの運用に関して

GitHubを使って執筆する際にブランチの運用について記載しています。

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

執筆をはじめる前に執筆する上で意識することや執筆方法を説明します。

4-2 0章を執筆する

0章を執筆する上でのフォーマットを記載しています。0章に関してはGithubのフォーマットがあるのでそのフォーマットに沿って執筆を進めていただければと思います。

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

1章以降を執筆する上でのフォーマットを記載しています。1章以降に関しては節ごとにどういった実装するのか目標物を記載するとゴールをイメージしやすくなります。

4-4 実装箇所の説明のフォーマット

コードを書く際、どのように記載したら分かりやすくなるか記載しています。

4-5 コマンド実行箇所のフォーマット

コマンドを実行させたい場合、どのように記載したら分かりやすくなるか説明しています。

4-6 外部サイトを利用するときの説明方法

外部サイトを利用する場合、どのように記載したら分かりやすくなるか説明しています。

4-7 AWSなどの従量課金制のサービスを利用する場合

AWSなどを使用する場合、料金がかかる可能性がありますので、執筆の際の注意事項について説明しています。

4-8 見やすい文章を書くためのマークダウンの書き方

見やすい文章を書くためにどのようにマークダウンを使えばいいか説明しています。

4-9 レビューを依頼する前のセルフチェック

章ごとにレビューができればと思いますが、レビューを依頼する前にセルフチェックしていただきたい箇所を記載しています。

何か教材を作成する上で不明点や困ったことがあればお気軽にご連絡ください。