documentation-engineer
技術ドキュメントの作成に特化した専門家です。明確で包括的なドキュメントを作成します。ユーザーがドキュメントの作成、READMEファイルの作成、コードの文書化を求める場合に使用してください。
description の原文を見る
Technical documentation expert for creating clear, comprehensive documentation. Use when user asks to write docs, create README, or document code.
SKILL.md 本文
ドキュメンテーション エンジニア
明確で包括的で保守性の高い技術ドキュメントを作成することに特化したエキスパート。
このスキルがアクティベートされるとき
以下の場合にアクティベートされます:
- ドキュメントを書くように求める
- README の作成をリクエストする
- 「docs」または「document this」と言及する
- API ドキュメントが必要な場合
ドキュメンテーション タイプ
1. README
すべてのプロジェクトには以下を含む README が必要です:
# Project Name
簡潔な説明 (何をするのか、なぜ存在するのか)
## クイックスタート
3 ステップ以下のインストールと使用方法。
## インストール
詳細なインストール手順。
## 使用方法
一般的な使用パターンの例。
## 設定
環境変数と設定オプション。
## 開発
テストの実行、ビルド、ローカルでの開発方法。
## 貢献
貢献者向けのガイドライン。
## ライセンス
ライセンス情報。
2. API ドキュメント
各エンドポイント/関数ごと:
- 説明: 何をするのか
- パラメータ: 名前、型、必須/オプション、説明
- 戻り値: 型と構造
- **
...
詳細情報
- 作者
- charon-fan
- ライセンス
- unknown
- 最終更新
- 不明
Source: https://github.com/charon-fan/agent-playbook / ライセンス: unknown
関連スキル
nature-response
Nature系ジャーナルの原稿修正に対する査読者への回答文について、下書き、チェック、または修正を行うことができます。査読者からのコメント、編集者の決定文、修正指示、回答案の作成、または大幅修正・軽微修正の対応方法に関するご相談があれば、対応いたします。査読報告書や回答文作成のサポートが必要な場合にご利用ください。
microsoft-docs
公式のMicrosoft文書を参照して、Azure、.NET、Agent Framework、Aspire、VS Code、GitHubなど様々な分野の概念、チュートリアル、コード例を検索します。デフォルトではMicrosoft Learn MCPを使用し、learn.microsoft.com外のコンテンツについてはContext7およびAspire MCPを使用します。
API Documentation Lookup
このスキルは、ユーザーが「Effect APIを調べる」「Effectドキュメントを確認する」「Effect関数のシグネチャを探す」「Effect.Xは何をするのか」「Effect.Xの使い方」「Effect APIリファレンス」「Effectドキュメントを取得する」といった質問をした場合や、公式のEffect-TS APIドキュメントから特定の関数シグネチャ、パラメータ、使用例を調べる必要がある場合に使用します。
knowledge-base
このスキルは、ヘルプセンターのアーキテクチャ設計、サポート記事の執筆、検索とセルフサービスの最適化が必要な場合に活用できます。ナレッジベース、ヘルプセンター、サポート記事、セルフサービス、記事テンプレート、検索最適化、コンテンツ分類、ヘルプドキュメントの設計・管理に関するあらゆるタスクで動作します。
markdown
GitHub Flavored Markdown標準に従ったMarkdownファイルのフォーマットと検証ができます。自動的なlinting処理と手動による意味的なレビューを組み合わせることで、ファイルの品質を確保します。
claude-md-enhancer
CLAUDE.mdファイルをプロジェクトタイプに合わせて分析・生成・改善します。ベストプラクティス、モジュール設計対応、技術スタックのカスタマイズに対応しています。新規プロジェクトの立ち上げ、既存のCLAUDE.mdファイルの改善、またはAI支援開発の標準化を図る際にご活用ください。