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