code-documentation

コードドキュメントスキル

目的

このスキルでは、TSDoc 形式のテンプレート、型のドキュメント作成ガイドライン、メンテナンスのワークフローを提供します。以下の場合に使用してください。

• 関数、型、モジュールの TSDoc コメントを作成または編集する
• ドキュメントの品質をレビューする
• 包括的な API ドキュメントを作成する
• 複雑な型構造をドキュメント化する
• ガイドラインに準拠していないコメント（パフォーマンスに関する注記、タイムスタンプ、インラインの説明）を整理する
• コードの変更と同期していない TSDoc を同期する
• 削除されたコードの孤立したドキュメントを削除する

重要な標準：@example セクションは設けません。テストとストーリーを実際に動作する例として使用します。

クイックリファレンス

• TSDoc の作成：生成ワークフローについては workflow.md を参照してください
• TSDoc のメンテナンス：整理と同期のガイドラインについては maintenance.md を参照してください

このスキルには、以下に関する詳細なテンプレートが含まれています。

• 公開 API 関数
• 内部モジュールのドキュメント
• 公開型と内部型
• ヘルパー関数
• 動作を規定する関数
• 特別な注釈（セキュリティ、パフォーマンス、非推奨）
• 型のドキュメント（複雑なオブジェクト、共用体、関数、ユーティリティ、ブランド型など）

ナビゲーション

• workflow.md - TSDoc 生成ワークフロー（4 フェーズ）
• maintenance.md - コメントのポリシー、同期タスク、孤立したドキュメントの扱い
• public-api-templates.md - 公開 API 向けのテンプレート
• internal-templates.md - 内部コードとモジュール向けのテンプレート
• type-documentation.md - 型のドキュメント作成に関する包括的なテンプレート

関連スキル

• typescript-lsp：ドキュメント作成ワークフロー中の型検証と調査に使用します。TSDoc 生成プロセスのフェーズ 1（型分析）とフェーズ 2（使用箇所の調査）に不可欠です。lsp-hover を実行してシグネチャを確認し、lsp-references を実行して使用箇所を探し、lsp-symbols を実行してファイル構造を把握してください。