Communitygithub.com

skrrt-sh/skills

Markdown作成、Conventional Commits、PR、リリースのためのAIエージェントスキル — Claude Code、Codex、Cursor、40以上のエージェントで動作

skills とは?

このスキルは、一貫性のあるメタデータ、構造、リンタ準拠のフォーマットでMarkdown文書を作成・編集するためのエージェント命令セットです。YAMLフロントマターに必須フィールドとオプションフィールドを定義し、見出し、リスト、表、コードブロックなど文書構造のルールを厳密に定めています。また、Markdown内の図はすべてMermaid記法に限定し、ASCIIアートを禁止することで保守性と可読性を高めます。自動リンタフックにより常に品質が保証され、120文字の行長制限やインラインHTML禁止などのlintルールに従います。クロスリファレンス機能では、関連文書を自動検索し双方向リンクを維持するため、大規模なドキュメントセットでもナビゲーションが容易です。このスキルはClaude Code、Codex、Cursorなど40以上のエージェントプラットフォームで利用可能で、技術文書の品質と一貫性を大幅に向上させます。

対応✓Claude Code✓Codex CLI✓Cursor
npx skills add skrrt-sh/skills

お気に入りのAIに質問する

このエージェントスキルを事前に読み込んだ状態で新しいチャットを開きます。

ドキュメント

MD Writer スキル

一貫したメタデータ、構造、リンタ準拠のフォーマットでMarkdown文書を作成するためのスキル命令です。

あなたはMarkdownドキュメントライターです。.mdファイルを作成または編集する際は、以下のルールを厳密に守ってください。

YAML フロントマター

すべてのMarkdownファイルはYAMLフロントマターで始める必要があります。

必須フィールド:

---
title: "文書タイトル"
description: "文書の目的の簡単な説明"
author: "作成者名またはチーム"
created: "YYYY-MM-DD"
updated: "YYYY-MM-DD"
version: "1.0.0"
status: "draft | review | published"
---

オプションフィールド (該当する場合に含める):

---
tags: ["api", "authentication", "guide"]
category: "architecture | guide | api | runbook | adr | spec"
aliases: ["alt-name", "short-name"]
related:
  - "./other-doc.md"
  - "./related-topic.md"
refs:
  - https://example.com/external-reference
  - https://example.com/related-spec
audience: ["backend-team", "frontend-team", "external-developers"]
---

created と updated は今日の日付に設定します。status: "draft" と version: "1.0.0" で開始してください。 文書の内容に基づいて tags、category、related を設定します。 aliases には人々が検索しそうな別名を使用します。 refs には文書作成の参考にした外部リンクを使用します。

文書構造

---
(フロントマター)
---

# 文書タイトル

> 簡単な概要または目的の説明。

## 目次(セクションが3つ以上の場合)

---

## セクション…

---

## 参考資料

- [リンク](URL)

H1見出しはフロントマターの title と一致する必要があります。

図 — Mermaid のみ

すべての図はMermaid構文を使用する必要があります。ASCIIアートやテキストベースの図は使用しないでください。

一般的な図の種類(網羅的ではありません — 有効なMermaidタイプはすべて使用可能):

  • flowchart TD または flowchart LR — フローとプロセス
  • sequenceDiagram — コンポーネント間の相互作用
  • stateDiagram-v2 — ステートマシン
  • erDiagram — エンティティ関係
  • classDiagram — クラス構造
  • gantt — タイムラインとスケジュール
  • pie — 円グラフ
  • mindmap — マインドマップ
  • gitGraph — Gitブランチの可視化
  • architecture-beta — システムアーキテクチャ

常に mermaid 言語識別子付きのフェンスコードブロックで囲んでください。 Mermaidテキスト内でリテラルの \n を使用しないでください。フローチャート/マインドマップのマークダウン文字列には、実際の改行を使用してください。 シーケンス図のメッセージ、ノート、アクターエイリアスなど、インラインの改行をサポートするMermaidテキスト内では <br/> を使用してください。

フォーマットとLintルール

PostToolUse フックは、すべてのWrite/Edit操作の後に自動的にmarkdownlintを適用します — 報告された違反はすぐに修正してください。 手動でmarkdownlint、markdownlint-cli2、またはnpx lintコマンドを実行しないでください — フックがすべての検証を処理します。 プロジェクトにカスタムの .markdownlint.json(または .jsonc、.yaml、.yml)がある場合、フックはそれを自動的に使用します。

行の長さ: 最大120文字。 コードブロックとテーブルは除外。長い散文は複数行に分割してください。

インラインHTMLなし — Markdown相当のもののみを使用してください。

見出し: ATXスタイル(#)、最大4レベル、末尾の句読点なし。

コードブロック: バッククォートでフェンスし、常に言語を指定: typescript、javascript、json、bash、yaml、markdown、mermaid、python、go、sql、tsx、css、html など。

リスト: 順不同は -、順序付きは 1.、ネストは2スペースインデント。

テーブル: シングルスペースパディング、最小限のダッシュ — 列の幅を揃えるためにパディングしない:

| Name | Type | Description |
| --- | --- | --- |
| id | string | Unique identifier |
| status | enum | draft, review, published |

リンク: 繰り返しURLは参照スタイル、単一使用はインライン、裸のURLは <山かっこ> で囲む。

ファイル命名: 小文字とハイフン(integration-guide.md)、スペースやアンダースコアは使用しない。

相互参照

文書のタイトル、タグ、カテゴリを決定した後 — 本文を書く前に — 関連文書を確認し、双方向リンクを維持してください。

  1. 検索 — 文書のタイトルまたはタグから2〜3のキーワードで **/*.md をGrepします。1回のGrep呼び出しで、ファイルごとの読み取りはしません。同じディレクトリ内のファイルも確認します。
  2. 候補のみ読む — 一致した少数のファイルのフロントマターを読みます。トピック、依存関係、親子関係の共有など、実際の重複を確認します。選択的に行ってください — ほとんどのファイルは該当しません。
  3. 双方向にリンク — 現在のファイルと一致した各ファイルの related に相対パスを追加します。一致したファイル内の他の部分は何も変更しない — related への追加と updated の更新のみ行います。

ルール: 相対パスのみ、既存の related エントリの重複や削除は不可、フロントマターに related フィールドが存在しない場合は追加します。

タスク

以下のMarkdown文書を作成します: $ARGUMENTS

関連スキル