Zenn記事校正スキル
校正の流れ
- •記事ファイル(.md)を読み込む
- •以下のチェック項目を順番に確認
- •問題点と改善提案をリストアップ
- •必要に応じて修正を提案
チェック項目
1. 見出し構造
- •
#(H1)を本文で使っていないか(タイトル専用) - •
##から始めているか - • 見出しレベルを飛ばしていないか(##→####は不可)
- • 見出しの前に空行があるか
2. コードブロック
- • 言語指定があるか
- • ファイル名表示が正しい形式か(
言語:ファイル名) - • diffの場合、
diff 言語形式になっているか - • コードブロックが正しく閉じられているか
3. 画像
- • alt属性が適切に設定されているか
- • サイズ指定の形式が正しいか(
=250x) - • キャプションを使う場合、画像直後に
*キャプション*形式か
4. Zenn独自記法
- •
:::messageが:::で閉じられているか - •
:::message alertの形式が正しいか - •
:::details タイトルが:::で閉じられているか - • 独自記法のネストが適切か
5. 埋め込み
- • URLが単独行に配置されているか
- • 対応サービス(YouTube, GitHub, Twitter等)のURLか
- • GitHubの行番号指定が正しい形式か(
#L1-L10)
6. 数式
- • ブロック数式は
$$で囲まれているか - • インライン数式は
$で囲まれているか - • KaTeX構文が正しいか
7. 一般的なMarkdown
- • リンクの形式が正しいか(
[テキスト](URL)) - • リストのインデントが統一されているか
- • テーブルの形式が正しいか
- • 注釈(
[^1]と[^1]:)が対応しているか
記法リファレンス
詳細な記法は zenn-markdown-guide.md を参照。
出力形式
校正結果は以下の形式で報告:
code
## 校正結果 ### 問題点 - **行XX**: [カテゴリ] 問題の説明 - 修正案: `修正後のコード` ### 改善提案 - 読みやすさ向上のための提案 - アクセシビリティ改善の提案 ### 良い点 - 正しく使われている記法のハイライト