Documentation Reflector Skill

このスキルは、プロジェクトの実装変更や新機能をドキュメントに正確に反映させるためのスキルです。

手順

以下の手順に従ってドキュメントの更新作業を行ってください。

1. 変更の確認 (Identify Changes)

最近の実装や仕様変更を確認します。

• •Git Log: git log コマンドを使用して、最近のコミットを確認します。特にウィジットの新機能や変更点に注目してください。
  • •例: git log --grep="feat" --since="1 week ago"
• •指示に基づく確認: ユーザーから特定のウィジットについての指示がある場合、そのウィジットのソースコードや関連PRを確認します。

2. 対象ドキュメントの特定 (Locate Docs)

変更に関連するドキュメントを特定します。

• •ウィジット説明書: docs/widgets/ 以下にある、該当ウィジットのファイル（[widget].md および [widget].en.md）。
• •全体ガイド: 新規ウィジットの場合は docs/widget_guide.md (.en.md) や docs/index.md (.en.md) も対象になります。

3. ドキュメントの更新 (Update Docs)

特定したドキュメントに変更内容を追記・修正します。

• •必須: 各ウィジットの説明書 (docs/widgets/*.md) は必ず最新の状態に保つ必要があります。
• •ユーザビリティ: 操作方法やUIの変更など、ユーザーの利便性に関わる変更は必ず記載してください。
• •省略可: 内部的なリファクタリングなど、ユーザーに見えない変更は記載をスキップしても構いません。

4. リンティング (Linting)

作業終了後、必ず以下のリントコマンドを実行してフォーマットを確認してください。

npx markdownlint-cli2 "**/*.md" "#node_modules"

• •エラーが出た場合は修正してください。

5. 完了

ドキュメントの更新とリントが完了したらタスク終了です。