- フォーマット
- `markdownlint-cli2 --fix`
- タブ幅によって箇条書きのネストが変わってしまうことがあるので注意(1敗)
- Save without formattingで保存する
- コードブロックの言語指定
- `shell`: シェルスクリプトやコマンド自体(出力なし)
- `console`: ターミナルセッションの実行例(プロンプト+入力+出力)
- 句読点の統一
- 表示崩れは無いですか(3敗)
- Markdown
- 箇条書きのネスト以深にコードブロックを書くとGitHub上でMDのシンタックスハイライトがされない
- " - (.*)\n\n\` " で検索する
- -> 箇条書きをやめる
- TeX
- VSCode上では表示されていても、GitHub上でレンダリングが上手くいかないことが多いのでGistとかでプレビューする(3敗)
- Exdoc
- mix docsして変更部分を見る(1敗)
- リンクをつける(1敗)
- 型には `t:` をつける
- 体裁
- 用語の統一
- コマンド中のファイル名等の命名は一貫していますか?
- 構成
- self-contained or 依存は正しいですか?
- 用語の定義より前に使用されていない
- 概要シーケンスレベルでは専門用語は前置きしてから使う
- 用語の説明はありますか(1敗)
- セットアップ方法等が使用前に書かれている
- 設定可能な値に説明がありますか
- TeX
- 式のexhausiveness (2敗)
- 記号の使い方
- `\backslach` より `\setminus`