Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 8 additions & 5 deletions 4/4-9.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,18 @@

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

## TextLintの実行
一般的な日本語の構文チェックに加え、Techpitのスタイルガイドに記載されているルールの一部をTextLintでチェックすることができます。
使用方法やTextLintでチェック可能なルールなど、詳細は[TextLintのリポジトリ](https://github.com/Techpit-Market/curriculum-textlint)をご確認ください。

{% hint style="info" %}
もしTextLintに対する改善要望や不具合報告などありましたら、[TextLintのリポジトリ](https://github.com/Techpit-Market/curriculum-textlint)にIssueもしくはPRを起票くださると助かります。
{% endhint %}

## Must (この項目の確認後レビュー提出をお願いします。)
### 全体
- [ ] **教材で達成したい目的を満たしている** [(詳細)](https://techpit-market.gitbook.io/host-guide/4/4-1#2-deshitaiwotashiteiruka)
- [ ] 見出しは1ページ1つのみ使用している [(詳細)](https://techpit-market.gitbook.io/host-guide/4/markdown#1-shinoi)
- [ ] h4以降の見出しを使用していない [(詳細)](https://techpit-market.gitbook.io/host-guide/4/markdown#1-shinoi)
- [ ] 外部サイトを利用する箇所では、操作する箇所を強調したスクリーションショットを使って操作方法を説明している [(詳細)](https://techpit-market.gitbook.io/host-guide/4/4-6#2-nosukurnshottowo)
- [ ] [GitHubの運用に関して](https://techpit-market.gitbook.io/host-guide/4/4-5)を一読した

Expand All @@ -26,15 +33,11 @@
- [ ] コードや技術に関しては1つずつ丁寧に説明している [(詳細)](https://techpit-market.gitbook.io/host-guide/4/4-4#5-kdono)
- [ ] 動作確認できる箇所は画像やGIF画像を使って実装イメージを表示している [(詳細)](https://techpit-market.gitbook.io/host-guide/4/4-3#dong-zuo-que-ren)
- [ ] ファイルパスはプロジェクトルートから書いている [(詳細)](https://techpit-market.gitbook.io/host-guide/4/4-4#3-won)
- [ ] コードブロックは拡張子とファイルパスを合わせて書いてある [(詳細)](https://techpit-market.gitbook.io/host-guide/4/4-4#4-kdoworikeru)
- [ ] コードを追加・編集する際はコメントアウトもしくはdiffでどこを編集するかを明示している [(詳細)](https://techpit-market.gitbook.io/host-guide/4/4-4#4-kdoworikeru)
- [ ] コマンドの実行結果を表示している [(詳細)](https://techpit-market.gitbook.io/host-guide/4/4-5#3-komandonowo)


## Advanced (編集者からの指摘はいたしますが、レビュー提出前に満たされている必要はありません。)
- [ ] 目標物を作成するまでの流れが書かれている [(詳細)](https://techpit-market.gitbook.io/host-guide/4/4-3#wosurumadenore-gruwosurumadenore)
- [ ] パートの最後の一言が書かれている [(詳細)](https://techpit-market.gitbook.io/host-guide/4/4-3#ptonono)
- [ ] 1パートの大きさがおおよそ1万字以内になっている [(詳細)](https://techpit-market.gitbook.io/host-guide/4/4-10#2-1pjinogai)
- [ ] コマンドを実行する箇所と実行結果を表示する場所は分かれている [(詳細)](https://techpit-market.gitbook.io/host-guide/4/4-5#3-komandonowo)
- [ ] コードのインデントが整っている
- [ ] コード量が多い場合、前後3行を除いて必要ないコードを省略している [(詳細)](https://techpit-market.gitbook.io/host-guide/4/4-4#kdono)
Expand Down
17 changes: 1 addition & 16 deletions 5.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,21 +18,7 @@

\*\*\*\*

### 2. textlintを使って文章を校正

Techpitでは文章を校正するためにtextlintのリポジトリを用意しています。

{% embed url="https://github.com/Techpit-Market/curriculum-textlint" %}

導入方法は上記のリポジトリのREADMEに記載しているのでそちらを参考に導入してください。

textlintを導入したら、コマンドを実行して、エラーが出た箇所を校正してください。ただ、全てのエラーを解消するのは難しいので、エラーの数を50個以内に収めていただければと思います。

textlintに関して何か不明な点があればお気軽に聞いてください。



### 3. 完成イメージの動画の作成
### 2. 完成イメージの動画の作成

Techpitでは、教材のセールスページに完成イメージの動画を掲載しています。

Expand All @@ -45,4 +31,3 @@ Techpitでは、教材のセールスページに完成イメージの動画を
動画には作成するアプリケーションの機能や画面を紹介してください。音声を入れる必要はありません。

なお動画のデータはMP4形式でお願いいたします。