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

執筆スタイルガイド通りに従って教材を執筆したら、Techpitの編集チームが教材をレビューします。レビューは章ごとに行います。

カリキュラムの提出の前に以下のチェック項目を満たしているか確認してください。

TextLintの実行

一般的な日本語の構文チェックに加え、Techpitのスタイルガイドに記載されているルールの一部をTextLintでチェックすることができます。 使用方法やTextLintでチェック可能なルールなど、詳細はTextLintのリポジトリをご確認ください。

もしTextLintに対する改善要望や不具合報告などありましたら、TextLintのリポジトリにIssueもしくはPRを起票くださると助かります。

Must (この項目の確認後レビュー提出をお願いします。)

全体

• 教材で達成したい目的を満たしている (詳細)

• 見出しは1ページ1つのみ使用している (詳細)

• 外部サイトを利用する箇所では、操作する箇所を強調したスクリーションショットを使って操作方法を説明している (詳細)

• GitHubの運用に関してを一読した

0章について

• 教材の学習後の姿が記載されている (詳細)

• 学習に必要な前提知識が記載されている (詳細)

• 教材の対象者が記載されている (詳細)

• 教材で学ばないことが記載されている (詳細)

• 教材で利用する技術のバージョンが記載されている (詳細)

• サンプルアプリの概要の説明がされている (詳細)

• 環境構築のカリキュラムがある (詳細)

1章以降

• パート(節)のゴールを書いている (詳細)

• コードや技術に関しては1つずつ丁寧に説明している (詳細)

• 動作確認できる箇所は画像やGIF画像を使って実装イメージを表示している (詳細)

• ファイルパスはプロジェクトルートから書いている (詳細)

• コマンドの実行結果を表示している (詳細)

Advanced (編集者からの指摘はいたしますが、レビュー提出前に満たされている必要はありません。)

• 目標物を作成するまでの流れが書かれている (詳細)

• コマンドを実行する箇所と実行結果を表示する場所は分かれている (詳細)

• コードのインデントが整っている

• コード量が多い場合、前後3行を除いて必要ないコードを省略している (詳細)

• 箇条書きが続く場合は表を活用している (詳細)

• MVCやDockerなどの概念を説明する際はテキストだけではなく画像を使って説明している

• AWSなどの料金が発生するサービスを使用する場合、料金についての説明がある詳細

• AWSなどの料金が発生するサービスを使用する場合、リソースの削除方法についての記述がある詳細

ご自身でカリキュラムのチェックが終わったら、Techpitの教材編集チームに連絡してください。作成された教材をレビューいたします。

レビュー後のフローは以下のようになります。

1. レビューを元に教材を修正（修正はPR上にしていただければと思います）

2. 教材を修正したことをTechpitの編集チームに連絡

3. Techpitの教材編集チームが教材をチェック

4. 1.2.3のフローを教材執筆が完了するまで繰り返す

5. 「5章 執筆後のチェック」に沿って、最初からの動作確認をする Techpitの教材編集チームがリリースに向けた準備を実施

6. リリース🎉

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