mcpField
W
writing-guidelines

writing-guidelines

github.com/nexu-ioドキュメント104.6k930 回インストール1 日前に更新
リポジトリ

writing-guidelines について

writing-guidelines は、固定された執筆ルールに照らしてファイルを確認するスキルです。結果を簡潔なファイル名・行番号形式で示し、任意で上流ルールとの差分も確認できます。

主な機能

  1. 01再現可能な固定ルールスナップショット
  2. 02任意の上流ルール比較
  3. 03指定ファイルやパターンの確認
  4. 04ファイル名と行番号で結果を表示

活用シーン

  1. 01一貫した執筆基準での文書確認
  2. 02指定ファイルやパターンのレビュー

インストール

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

$npx skills add https://github.com/nexu-io/open-design --skill writing-guidelines

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

同梱ファイルLICENSEreferences/guidelines.md

詳細

ライティングガイドライン

ファイルがライティングガイドラインに準拠しているか確認します。

動作の仕組み

  1. references/guidelines.md にある固定版のガイドラインを読み込みます。これが、デフォルトで再現性のある実行方法です。
  2. 必要に応じて、以下の上流 URL から最新のガイドラインを取得し、固定版のスナップショットと比較して変更点を確認します。
  3. 指定されたファイルを読み込みます(または、対象ファイルやパターンをユーザーに尋ねます)。
  4. ガイドラインのすべてのルールに照らして確認します。
  5. 指摘事項を簡潔な file:line 形式で出力します。

ガイドラインの参照元

デフォルト(固定版): references/guidelines.md に格納されているコピーが、デフォルトの実行方法です。これは上流のガイドラインの固定スナップショットであり、どの実行環境でもスキルが再現性のある結果を生成できることを保証します。

上流(最新): 最新のルールを必要とするユーザーは、以下のライブソースを利用できます。

https://raw.githubusercontent.com/vercel-labs/writing-guidelines/main/command.md

ライブ版の取得は任意です。固定版のスナップショットが常に基準となります。

使用方法

ユーザーがファイルまたはパターンの引数を指定した場合:

  1. references/guidelines.md をデフォルトの参照元として読み込みます。
  2. 必要に応じて上流 URL を取得し、更新を確認します。
  3. 指定されたファイルを読み込みます。
  4. すべてのルールを適用します。
  5. ガイドラインで指定された形式を使って指摘事項を出力します。

ファイルが指定されていない場合は、確認するファイルをユーザーに尋ねます。

コメント