| name | markdown-writing |
| description | Markdown 文書作成時の重要なルール。図表は mermaid/plantUML を使用 (ASCII ART 禁止、ツリー構造のみ例外)、概ね 300 行以内、超える場合は順序 prefix (01-, 02-, ...) 付きで分割する。 |
| when_to_use | Markdown 文書 / 図表を作成 / 編集するとき。Triggers: 'Markdown作成', 'ドキュメント作成', '文書作成', '図を描く', 'mermaid', 'create document', 'write docs' |
| allowed-tools | ["Read","Write","Edit"] |
Markdown Writing Skill
重要ルール
1. 図表作成ルール
mermaid または plantUML を使用(ASCII ART禁止、ツリー除く)
graph TD
A[開始] --> B{条件判定}
B -->|Yes| C[処理A]
B -->|No| D[処理B]
2. 文書の長さと分割ルール
| ページ数 | 対応 |
|---|
| ~300行 | そのまま |
| 301~600行 | 2ファイルに分割 |
| 600行以上 | セクションごとに分割 |
分割時のファイル名: 順序prefix(01-, 02-, ...)+ ケバブケース
docs/feature-guide/
├── 01-introduction.md
├── 02-installation.md
└── 03-usage.md
チェックリスト
詳細ガイド
| ファイル | 内容 |
|---|
01-diagram-guide.md | mermaid/plantUML記法、よくある間違い |
関連リソース