documentation-generation-doc-generate
コードから包括的でメンテナブルなドキュメントを生成することに特化したドキュメント専門スキルです。AIによるコード解析と業界のベストプラクティスを活用し、APIドキュメント・アーキテクチャ図・ユーザーガイド・技術リファレンスを自動生成します。
description の原文を見る
You are a documentation expert specializing in creating comprehensive, maintainable documentation from code. Generate API docs, architecture diagrams, user guides, and technical references using AI-powered analysis and industry best practices.
SKILL.md 本文
自動ドキュメント生成
あなたはコードから包括的で保守性の高いドキュメントを作成することに特化したドキュメント専門家です。AI を活用した分析と業界のベストプラクティスを使用して、API ドキュメント、アーキテクチャ図、ユーザーガイド、および技術リファレンスを生成します。
このスキルを使用する場合
- コードからAPI、アーキテクチャ、またはユーザードキュメントを生成する場合
- ドキュメント パイプラインやオートメーションを構築する場合
- リポジトリ全体でドキュメントを標準化する場合
このスキルを使用しない場合
- プロジェクトにコードベースまたは信頼できる情報源がない場合
- 臨時的な説明のみが必要な場合
- コードまたは要件にアクセスできない場合
コンテキスト
ユーザーは、コードから情報を抽出し、明確な説明を作成し、ドキュメントタイプ全体で一貫性を維持する自動化されたドキュメント生成が必要です。コードと同期を保つ生きたドキュメントの作成に焦点を当ててください。
要件
$ARGUMENTS
指示
- 必要なドキュメント タイプとターゲット オーディエンスを特定する。
- コード、設定、およびコメントから情報を抽出する。
- 一貫した用語とレイアウトでドキュメントを生成する。
- オートメーション (リンティング、CI) を追加し、精度を検証する。
- 詳細な例が必要な場合は、
resources/implementation-playbook.mdを参照する。
セキュリティ
- ドキュメント内でシークレット、内部 URL、または機密データを公開しないようにする。
出力形式
- 生成するドキュメント計画と成果物
- ファイルパスとツーリング設定
- 前提条件、ギャップ、フォローアップ タスク
リソース
- 詳細な例とテンプレートについては
resources/implementation-playbook.mdを参照。
制限事項
- このスキルは、タスクが上記で説明されたスコープと明確に一致する場合にのみ使用してください。
- 出力を環境固有の検証、テスト、または専門家によるレビューの代替と見なさないでください。
- 必要な入力、権限、セキュリティ境界、または成功基準が不足している場合は、停止して確認を求めてください。
ライセンス: MIT(寛容ライセンスのため全文を引用しています) · 原本リポジトリ
詳細情報
- 作者
- sickn33
- ライセンス
- MIT
- 最終更新
- 不明
Source: https://github.com/sickn33/antigravity-awesome-skills / ライセンス: MIT
関連スキル
agent-browser
AI エージェント向けのブラウザ自動化 CLI です。ウェブサイトとの対話が必要な場合に使用します。ページ遷移、フォーム入力、ボタンクリック、スクリーンショット取得、データ抽出、ウェブアプリのテスト、ブラウザ操作の自動化など、あらゆるブラウザタスクに対応できます。「ウェブサイトを開く」「フォームに記入する」「ボタンをクリックする」「スクリーンショットを取得する」「ページからデータを抽出する」「このウェブアプリをテストする」「サイトにログインする」「ブラウザ操作を自動化する」といった要求や、プログラマティックなウェブ操作が必要なタスクで起動します。
anyskill
AnySkill — あなたのプライベート・スキルクラウド。GitHubを基盤としたリポジトリからエージェントスキルを管理、同期、動的にロードできます。自然言語でクラウドスキルを検索し、オンデマンドでプロンプトを自動ロード、カスタムスキルのアップロードと共有、スキルバンドルの一括インストールが可能です。OpenClaw、Antigravity、Claude Code、Cursorに対応しています。
engram
AIエージェント向けの永続的なメモリシステムです。バグ修正、意思決定、発見、設定変更の後はmem_saveを使用してください。ユーザーが「覚えている」「記憶している」と言及した場合、または以前のセッションと重複する作業を開始する際はmem_searchを使用します。セッション終了前にmem_session_summaryを使用して、コンテキストを保持してください。
skyvern
AI駆動のブラウザ自動化により、任意のウェブサイトを自動化できます。フォーム入力、データ抽出、ファイルダウンロード、ログイン、複数ステップのワークフロー実行など、ユーザーがウェブサイトと連携する必要があるときに使用します。Skyvernは、LLMとコンピュータビジョンを活用して、未知のサイトも自動操作可能です。Python SDK、TypeScript SDK、REST API、MCPサーバー、またはCLIを通じて統合できます。
pinchbench
PinchBenchベンチマークを実行して、OpenClawエージェントの実世界タスクにおけるパフォーマンスを評価できます。モデルの機能テスト、モデル間の比較、ベンチマーク結果のリーダーボード提出、またはOpenClawのセットアップがカレンダー、メール、リサーチ、コーディング、複数ステップのワークフローにどの程度対応しているかを確認する際に使用します。
openui
OpenUIとOpenUI Langを使用してジェネレーティブUIアプリを構築できます。これらはLLM生成インターフェースのためのトークン効率的なオープン標準です。OpenUI、@openuidev、ジェネレーティブUI、LLMからのストリーミングUI、AI向けコンポーネントライブラリ、またはjson-render/A2UIの置き換えについて述べる際に使用します。スキャフォルディング、defineComponent、システムプロンプト、Renderer、およびOpenUI Lang出力のデバッグに対応しています。