mcpField
F
format-markdown

format-markdown

github.com/arthurzakirovドキュメント0170 回インストール3 日前に更新
リポジトリ

format-markdown について

有効で読みやすく、意図に忠実な文書を作成・編集するための Markdown スキルです。執筆者やエージェント向けに、機械処理されるファイルや変化しやすい参照情報の扱いも示します。

主な機能

  1. 01意味と例の保持
  2. 02文法と Markdown 構文の修正
  3. 03YAML とコードフェンスの整合性維持
  4. 04解決可能なファイル参照へのリンク
  5. 05機械処理と人間の閲覧への配慮

活用シーン

  1. 01README や Markdown ガイドの編集
  2. 02メモや文字起こしの文書化
  3. 03AGENTS.md や SKILL.md の保守
  4. 04パスやバージョンを含む Markdown の更新

インストール

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

$npx skills add https://github.com/arthurzakirov/systemsmith --skill format-markdown

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

詳細

Markdown Formatter

ユーザーのリクエスト:$ARGUMENTS

表とリスト、階層構造、文章、図など、表現方法を選ぶ際は、information-representation-design を適用してください。情報の選択、抽象化の階層化、振り分け、段階的な開示には、relevance-first-information-design を適用してください。ソースが生のメモ、口述記録、文字起こし、またはブレインストーミングであり、ソースの順序どおりに写すのではなく、概念上の構造を再構成する必要がある場合は、thoughts-to-artifact も適用してください。

出力に現状の値、スナップショット、ファイルツリー、バージョン、パス、その他、時間とともに古くなる可能性のあるデータが含まれる場合は、living-artifacts も適用してください。

主なタスク

Markdown アーティファクトを作成または編集し、妥当で、読みやすく、目的の箇所を見つけやすく、意図された意味に忠実な状態にしてください。AGENTS.md や SKILL.md など、機械処理される Markdown は、二者を対象とするアーティファクトとして扱ってください。人間による確認やナビゲーションを損なうことなく、エージェントが正しく利用できるよう最適化してください。

内容の保持に関するルール

  • 既存の重要な情報、ニュアンス、例をすべて保持してください。
  • 意味を変えずに修正できる場合は、明らかなスペルミス、文法の誤り、文字起こしのノイズ、不正な文、Markdown の構文エラーを修正してください。
  • 欠けている内容を作り足さないでください。
  • 意味を変えずに明確さを高められる場合に限り、内容の順序を入れ替えてください。
  • 追加のガイダンスをドキュメントの内容に含めずに残す必要がある場合は、適切に HTML コメントを使用してください。

Markdown 固有のルール

  • ソースで意味を持つ $ 構文はそのまま保持してください。
  • 対象のアーティファクトで YAML/フロントマターが必要な場合は、妥当な形式を保ってください。
  • 妥当な見出しレベルを使用し、見た目のためだけにレベルを飛ばさないでください。
  • 適切な場合は、リポジトリ、フォルダー、ファイル、コマンド、関数、変数、設定キー、その他のリテラルな技術識別子にインラインコードを使用してください。
  • 維持管理する Markdown アーティファクトでは、実際の参照先が存在する具体的なファイル参照に、正しい相対リンクを設定してください。
  • コードフェンスの構文を妥当な状態に保ち、言語識別子が分かる場合は意図されたものを保持してください。
  • リテラル文字が誤って解釈される場合は、Markdown 構文をエスケープするか、構成を変更してください。

セルフチェック

  • 意味が保持されている。
  • 事実を作り足していない。
  • Markdown が意図どおりに解析される。
  • フロントマターとコードフェンスが妥当な状態に保たれている。
  • 解決可能な参照先があるファイルやパスには、すべて意味のあるクリック可能な Markdown リンクが設定されている。解決できない参照先は、リンク先があるかのように示さず、その旨を明記している。
  • 機械処理される Markdown が、人間にとっても確認や移動をしやすい状態に保たれている。
  • 表現方法と関連性/段階的開示のルールは、ここで再定義せず、それぞれの専用スキルに従っている。
  • 生の思考を変換する場合、thoughts-to-artifact に従って例やニュアンスを保持している。

コメント