53 lines
4.1 KiB
Markdown
53 lines
4.1 KiB
Markdown
---
|
||
description: 'ドキュメントとコンテンツ作成標準'
|
||
applyTo: '**/*.md'
|
||
---
|
||
|
||
## Markdownコンテンツルール
|
||
|
||
以下のMarkdownコンテンツルールがバリデータで強制されます：
|
||
|
||
1. **見出し**: コンテンツを構造化するために適切な見出しレベル（H2、H3など）を使用する。H1見出しはタイトルに基づいて生成されるため使用しない。
|
||
2. **リスト**: リストには箇条書きまたは番号付きリストを使用する。適切なインデントと間隔を確保する。
|
||
3. **コードブロック**: コードスニペットにはフェンス付きコードブロックを使用する。構文ハイライトのため言語を指定する。
|
||
4. **リンク**: リンクには適切なMarkdown構文を使用する。リンクが有効でアクセス可能であることを確保する。
|
||
5. **画像**: 画像には適切なMarkdown構文を使用する。アクセシビリティのためにaltテキストを含める。
|
||
6. **表**: 表形式データにはMarkdownテーブルを使用する。適切なフォーマットと配置を確保する。
|
||
7. **行長**: 読みやすさのため行長を400文字に制限する。
|
||
8. **空白**: セクションを分離し読みやすさを向上させるために適切な空白を使用する。
|
||
9. **フロントマター**: 必要なメタデータフィールドを含むYAMLフロントマターをファイルの最初に含める。
|
||
|
||
## フォーマットと構造
|
||
|
||
Markdownコンテンツのフォーマットと構造については、以下のガイドラインに従ってください：
|
||
|
||
- **見出し**: H2には`##`、H3には`###`を使用する。見出しが階層的に使用されることを確保する。コンテンツがH4を含む場合は再構成を推奨し、H5の場合はより強く推奨する。
|
||
- **リスト**: 箇条書きには`-`、番号付きリストには`1.`を使用する。ネストしたリストは2スペースでインデントする。
|
||
- **コードブロック**: フェンス付きコードブロックを作成するために三重バッククォート（```）を使用する。構文ハイライトのため開始バッククォートの後に言語を指定する（例：```csharp）。
|
||
- **リンク**: リンクには`[link text](URL)`を使用する。リンクテキストが説明的でURLが有効であることを確保する。
|
||
- **画像**: 画像には``を使用する。altテキストに画像の簡潔な説明を含める。
|
||
- **表**: 表を作成するために`|`を使用する。列が適切に配置され、ヘッダーが含まれることを確保する。
|
||
- **行長**: 読みやすさを向上させるために80文字で行を改行する。長い段落にはソフトな改行を使用する。
|
||
- **空白**: セクションを分離し読みやすさを向上させるために空白行を使用する。過度の空白を避ける。
|
||
|
||
## 検証要件
|
||
|
||
以下の検証要件への準拠を確保してください：
|
||
|
||
- **フロントマター**: YAMLフロントマターに以下のフィールドを含める：
|
||
|
||
- `post_title`: 投稿のタイトル。
|
||
- `author1`: 投稿の主要著者。
|
||
- `post_slug`: 投稿のURLスラッグ。
|
||
- `microsoft_alias`: 著者のMicrosoftエイリアス。
|
||
- `featured_image`: 注目画像のURL。
|
||
- `categories`: 投稿のカテゴリ。これらのカテゴリは/categories.txtのリストからである必要がある。
|
||
- `tags`: 投稿のタグ。
|
||
- `ai_note`: 投稿の作成にAIが使用されたかどうかを示す。
|
||
- `summary`: 投稿の簡潔な要約。可能な場合はコンテンツに基づいて要約を推奨する。
|
||
- `post_date`: 投稿の公開日。
|
||
|
||
- **コンテンツルール**: コンテンツが上記で指定されたMarkdownコンテンツルールに従うことを確保する。
|
||
- **フォーマット**: コンテンツがガイドラインに従って適切にフォーマットされ構造化されることを確保する。
|
||
- **検証**: ルールとガイドラインへの準拠をチェックするために検証ツールを実行する。
|