Agent Skills by ALSEL
汎用ドキュメント⭐ リポ 0品質スコア 35/100

doc-writing

コード生成ドキュメント - コードとコンテキストから正確で有用なドキュメントを生成します

description の原文を見る

文档编写 - 从代码和上下文生成准确、有用的文档

SKILL.md 本文

注意: このスキルのライセンスは ライセンス未確認 です。本サイトでは本文プレビューのみを表示しています。利用前に GitHub の原本でライセンス条件をご確認ください。

ドキュメント作成

コードとコンテキストから正確で有用なドキュメントを生成します。


ドキュメント種別の識別

種別適用場面主な内容
READMEプロジェクト/モジュールの説明何か、使い方、開発方法
API ドキュメントエンドポイントの説明パス、パラメータ、戻り値、サンプル
アーキテクチャドキュメントシステム設計モジュール関係、データフロー、設計判断
変更履歴バージョンリリース新機能、修正、破壊的変更
ユーザーガイドHow-to手順、サンプル、よくある質問

作成フロー

1. ドキュメント目標の確定

  • 読み手は誰か?(新人、ユーザー、メンテナー)
  • ドキュメント種別?(上の表から選択)
  • 対象範囲?(プロジェクト全体、単一モジュール、単一機能)

2. 情報の収集

  • 関連コードを読み、コア・ロジックを抽出する
  • 既存ドキュメントを確認(重複や矛盾を回避)
  • テストケースを確認(想定される動作を理解)
  • git log を確認(変更履歴を理解)

3. コンテンツの整理

ドキュメント種別に応じて対応す

...

詳細情報

作者
walker-hzx
リポジトリ
walker-hzx/AI-Assistant
ライセンス
不明
最終更新
2026/3/23

Source: https://github.com/walker-hzx/AI-Assistant / ライセンス: 未指定

本サイトは GitHub 上で公開されているオープンソースの SKILL.md ファイルをクロール・インデックス化したものです。 各スキルの著作権は原作者に帰属します。掲載に問題がある場合は info@alsel.co.jp または /takedown フォームよりご連絡ください。
原作者: walker-hzx · walker-hzx/AI-Assistant · ライセンス: ライセンス未確認