技能 documentation-templates
📦

documentation-templates

安全

プロフェッショナルなドキュメントを迅速に作成

このスキルは、README ファイル、API ドキュメント、コードコメント、チェンジログ、AI フレンドリーなドキュメント形式のすぐに使えるテンプレートを提供します。

支持: Claude Codex Code(CC)
🥉 74 青铜
1

下载技能 ZIP

2

在 Claude 中上传

前往 设置 → 功能 → 技能 → 上传技能

3

开启并开始使用

测试它

正在使用“documentation-templates”。 documentation-templates を使用して Node.js API の README を作成

预期结果:

以下のセクションを含む完全な README.md：タイトル + 一行説明、Quick Start、Features、設定テーブル、API リファレンスリンク、コントリビューションガイドライン、ライセンス

正在使用“documentation-templates”。 documentation-templates を使用して GET /users エンドポイントをドキュメント化

预期结果:

エンドポイントの説明、パラメータテーブル（id: string、必須）、レスポンスコード（200、404）、およびリクエスト/レスポンス例を含む API ドキュメント

正在使用“documentation-templates”。 documentation-templates を使用してデータベース選択の ADR を作成

预期结果:

ステータス（Accepted/Deprecated/Superseded）、コンテキスト（なぜ決定が必要か）、決定（何が決定されたか）、結果（トレードオフ）を含む ADR ドキュメント

安全审计

安全
v1 • 2/24/2026

All 23 static findings are false positives. The skill contains only markdown documentation templates with no executable code. The detected patterns (external_commands, weak cryptographic algorithms, system reconnaissance) are markdown code fences, plain English text, and API documentation placeholders - not actual security risks.

1
已扫描文件
200
分析行数
0
发现项
1
审计总数
未发现安全问题

检测到的模式

External Command Execution (False Positive)Weak Cryptographic Algorithm (False Positive)System Reconnaissance (False Positive)
审计者: claude

质量评分

38
架构
100
可维护性
87
内容
50
社区
100
安全
91
规范符合性

你能构建什么

新規プロジェクトセットアップ

README、API ドキュメント、チェンジログのテンプレートを使用して、新規プロジェクトのドキュメントを迅速にスケフォールディングします。

ドキュメント標準

標準化されたテンプレートを使用して、チームプロジェクト全体で一貫したドキュメントスタイルを維持します。

AI エージェント統合

Claude や Codex などの AI エージェントが効果的に理解・活用できるドキュメントを作成します。

试试这些提示

基本的な README を作成 
documentation-templates スキルを使用して、[project type] プロジェクトの README.md を作成してください。Quick Start、Features、Configuration セクションを含めてください。
API エンドポイントをドキュメント化 
documentation-templates スキルを使用して、[list endpoints] のエンドポイントを持つ REST API の API ドキュメントを作成してください。
コードコメントを記述 
documentation-templates スキルを使用して、[describe function purpose] 関数に JSDoc コメントを追加してください。
アーキテクチャ決定記録を作成 
documentation-templates スキルを使用して、[decision title] の ADR を作成してください。Context、Decision、Consequences セクションを含めてください。

最佳实践

  • 詳細なドキュメントを追加する前に、必須セクション（タイトル、クイックスタート、機能）から始める
  • テンプレートを出発点として使用し、プロジェクトのニーズに合わせて構造を調整する
  • ドキュメントを最新の状態に保つ - 古いドキュメントはドキュメントがないよりも悪い
  • ユーザーが迅速に理解できるよう、ドキュメントに例を含める

避免

  • プロジェクトコンテキストに合わせてカスタマイズせずにテンプレートをそのままコピーしない
  • ユーザー向け README ファイルに実装詳細をドキュメント化しない
  • Quick Start セクションを省略しない - ユーザーは迅速に始めたい
  • AI エージェントが解析できない古いドキュメント形式を使用しない

常见问题

このスキルはどのツールと互換性がありますか？
このスキルは Claude、Codex、Claude Code と連携します。Read、Glob、Grep ツールと併用してください。
テンプレートを修正する必要がありますか？
はい、テンプレートは出発点です。プレースホルダーと構造を特定のプロジェクトニーズに合わせて調整してください。
商用プロジェクトで使用できますか？
はい、このスキルは MIT ライセンスでライセンスされており、帰属表示の下で商用利用が可能です。
llms.txt とは何ですか？
llms.txt は AI クローラーおよびエージェント向けに設計されたドキュメント形式です。AI モデルが容易に解析・理解できる構造化された概要を提供します。
自動生成ドキュメントとどう違いますか？
このスキルは明瞭性とスキャンのしやすさを重視した人間が執筆したテンプレートを提供します。自動生成されたドキュメントは適切な構造とコンテキストに欠けることがよくあります。
このスキルは実際のコードを生成できますか？
いいえ、このスキルはドキュメント構造とテンプレートのみを生成します。実行可能コードは生成しません。

开发者详情

作者

sickn33

许可证

MIT

仓库

https://github.com/sickn33/antigravity-awesome-skills/tree/main/skills/documentation-templates

引用

main

文件结构

📄 SKILL.md