doc-writing
コード生成ドキュメント - コードとコンテキストから正確で有用なドキュメントを生成します
description の原文を見る
文档编写 - 从代码和上下文生成准确、有用的文档
SKILL.md 本文
ドキュメント作成
コードとコンテキストから正確で有用なドキュメントを生成します。
ドキュメント種別の識別
| 種別 | 適用場面 | 主な内容 |
|---|---|---|
| README | プロジェクト/モジュールの説明 | 何か、使い方、開発方法 |
| API ドキュメント | エンドポイントの説明 | パス、パラメータ、戻り値、サンプル |
| アーキテクチャドキュメント | システム設計 | モジュール関係、データフロー、設計判断 |
| 変更履歴 | バージョンリリース | 新機能、修正、破壊的変更 |
| ユーザーガイド | How-to | 手順、サンプル、よくある質問 |
作成フロー
1. ドキュメント目標の確定
- 読み手は誰か？（新人、ユーザー、メンテナー）
- ドキュメント種別？（上の表から選択）
- 対象範囲？（プロジェクト全体、単一モジュール、単一機能）
2. 情報の収集
- 関連コードを読み、コア・ロジックを抽出する
- 既存ドキュメントを確認（重複や矛盾を回避）
- テストケースを確認（想定される動作を理解）
- git log を確認（変更履歴を理解）
3. コンテンツの整理
ドキュメント種別に応じて対応す
...
詳細情報
- 作者
- walker-hzx
- ライセンス
- unknown
- 最終更新
- 2026/3/23
Source: https://github.com/walker-hzx/AI-Assistant / ライセンス: 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支援開発の標準化を図る際にご活用ください。