curriculum-format

教材の管理と各章の記載フォーマットを示すリポジトリです。

リポジトリは以降で説明する規則で管理されます。

ディレクトリ階層規則

curriculumディレクトリの配下に章ディレクトリを配置する
章ディレクトリ配下にはパートごとにマークダウン形式のファイル（パートファイル）を配置する

ファイル命名規則

章ディレクトリは「章番号. 章タイトル」のように章番号とドット(.)と半角空白の後に章タイトルを付けて管理する
パートファイルも同様に「パート番号. パートタイトル.md」のような形式にする

例

./curriculum
  └── 0. はじめに
  │     └── 1. Trello風ToDoタスク管理アプリを作成しよう！.md
  │     └── 2. Ruby on Railsの環境構築 (macOS).md
  │     └── 3. Cloud9を利用する手順.md
  │     └── 4. kanbanの設計を考える.md
  │     └── 5. エラーが出たときの心得.md
  │
  └── 1. 新規Railsアプリケーションの作成
  │     └── 1. 新規Railsプロジェクトの作成 (Rails6).md
  │
  └── 2. トップページの作成
  │     └── 1. MVCについて学ぼう.md
  │     └── 2. 仮のトップページを表示.md
   ...

curriculum-formatの使い方

0章を執筆する場合

教材のパートを執筆する際は、curriculum/0. はじめにディレクトリ内の1. 教材の概要.mdや2. 環境構築.mdなどのファイルのマークダウンフォーマットの案内に従いながら書き換えてカリキュラムを執筆してください。

curriculum/0. はじめにディレクトリの内容はお渡ししたスタイルガイドの4-2 セクション0 (0章) を執筆するの内容などを元に作成しています。

1章以降を執筆する場合

教材のパートを執筆する前に、curriculum/1. xxxディレクトリ内の1. 1章以降のフォーマット.mdファイルのマークダウンをコピー&ペーストして案内に従いながらカリキュラムを執筆してください。

1. 1章以降のフォーマット.mdの内容はお渡ししたスタイルガイドの4-3 セクション1以降を執筆するの内容を元に作成しています。

curriculum-format に関して何か不明点や要望がございましたらお気軽にSlackでご連絡ください。よろしくお願いいたします。