audit

概要

auditスキルとは？

auditは、フロントエンドのコードベースに対して体系的な技術品質チェックを行う専門ツールです。アクセシビリティ、パフォーマンス、テーマ適用、レスポンシブデザイン、アンチパターンの5つの主要分野に焦点を当てています。このスキルは、P0〜P3の重大度評価付きのスコアレポートを生成し、改善のための具体的なアクションプランを提供します。ウェブアクセシビリティやパフォーマンス最適化、全体的なフロントエンド品質の高い基準を目指すチームに最適です。

誰がauditを使うべきか？

auditは、フロントエンド開発者、UI/UXデザイナー、技術リードを対象に設計されており、ウェブインターフェースの品質を評価・記録したい場合に役立ちます。特に、修正や詳細なデザインレビューを始める前に、コードレベルの問題を明確かつ客観的に監査したい時に有効です。

解決できる課題

• アクセシビリティの不足箇所の特定（例：コントラスト、ARIA、キーボード操作）
• パフォーマンスのボトルネックの検出
• テーマの一貫性チェック
• レスポンシブデザインの実装評価
• 一般的なフロントエンドのアンチパターンの検出

使い方

インストール手順

1. auditスキルのインストール：
   以下のコマンドでプロジェクトにスキルを追加します：

   npx skills add https://github.com/pbakaus/impeccable --skill audit

2. 主要ファイルの確認：

   • 全体のスキル概要と使用方法はSKILL.mdから始めてください。
   • 補足ドキュメントはREADME.md、AGENTS.md、metadata.jsonを参照。
   • 追加のコンテキストやヘルパースクリプトはrules/、resources/、references/、scripts/フォルダにあります。

監査の実行

• 準備：
  • まず/frontend-designを呼び出してデザインコンテキストを収集し、アンチパターンや原則を読み込みます。
  • デザインコンテキストがない場合は、スキルのドキュメントに従い/teach-impeccableを実行してください。
• 監査の実行：
  • 関連する引数（機能名、ページ名、コンポーネント名など）を指定してauditスキルを実行します。
  • コードベースをスキャンし、各項目のスコアと重大度レベルを含むJSONレポートを出力します。
• 次のステップ：
  • 生成されたレポートを使って修正の優先順位を決めてください。auditスキルは問題を記録しますが、自動で修正は行いません。

auditを使うタイミング

• 大きなリリースやコードレビューの前
• 新規プロジェクトやチームのオンボーディング時
• フロントエンド品質保証の継続的インテグレーションの一環として

よくある質問

auditスキルは何をチェックしますか？

auditスキルは、フロントエンドコードのアクセシビリティ、パフォーマンス、テーマ適用、レスポンシブデザイン、アンチパターンを体系的にレビューします。重大度評価付きのスコアレポートと実行可能な推奨事項を出力します。

auditは問題を自動で修正しますか？

いいえ、auditは技術的な問題を特定し記録しますが、自動修正は行いません。レポートを参考にして他のツールや手動で修正を進めてください。

auditはデザイン批評に適していますか？

いいえ、auditはコードレベルで計測可能なフロントエンド品質に焦点を当てています。デザイン批評には補完的なスキルやワークフローを利用してください。

詳細はどこで確認できますか？

リポジトリのFilesタブを開くと、ネストされたリファレンスやヘルパースクリプトを含む全ての補足ドキュメントを閲覧できます。最も関連性の高いガイダンスはSKILL.mdからご覧ください。