mcpField
M
md-style

md-style

github.com/jimwellerドキュメント69 回インストール
リポジトリ

md-style について

経験豊富なエンジニア向けに、READMEの構成と節の順序を定めるスキルです。開発の経緯や将来計画ではなく、プロジェクトの現状を簡潔に記述します。

主な機能

  1. 01READMEの節の順序指定
  2. 02現状を中心とした記述
  3. 03冗長な内容とロードマップの除外
  4. 04表とコードの書式指針

活用シーン

  1. 01エンジニアリングREADMEの構成
  2. 02長すぎるREADMEの編集
  3. 03設定とテスト情報の記述

インストール

コマンドをコピーしてターミナルで実行します。

$npx skills add https://github.com/jimweller/clanker-skills --skill md-style

インストール後、Claude Code で/md-styleを入力して読み込まれたか確認します。

詳細

README スタイルガイド

経験豊富なエンジニア向けに、簡潔で直接的な README を作成します。

文体

ここでは文章のスタイルを定義しません。clanker-prose プラグインの prose-contract が文体を規定し、SessionStart フックのポインターを介して次の 2 つのセクションが挿入されます。

  • Ghostwriting for Other Humans - README は別の人間が読むため、代筆の契約が適用されます。事実を最小限にし、1 文に 1 つの事実を記載し、すべての単語に削除テストを実施します
  • Banned Patterns in All Writing - 誇張表現、対立する表現、架空の対比、絵文字、エムダッシュなど、禁止されている単語や構文の一覧です

このスキルでは、README に含める内容と、その順序を扱います。

原則

  • 無駄を省く - 目次、冗長な説明、開発の経緯は省略します
  • ロードマップは載せない - 計画や決定事項ではなく、現在の状態のみを記録します。README はエンジニアリング仕様書であり、プロジェクト計画書や変更履歴ではありません。

構成

セクションの順序は、概要、前提条件、使い方、アーキテクチャ、設定、テスト、ファイル構成です。H1 の直下に、目的を 1 行で記載します。

除外する項目

  • 目次
  • 冗長なトラブルシューティングガイド
  • 開発上の決定事項や経緯
  • 今後の計画やロードマップ
  • 概念についての長い説明
  • 類似した内容の例を複数掲載すること
書式
  • 構造化データ（コンポーネント、変数、テストカバレッジ）には表を使用します
  • コマンドや例にはコードブロックを使用します
  • 強調には太字を控えめに使用します

コメント

Markdown 対応