luongnv89/doc-generator
zh/03-skills/doc-generator/SKILL.md
从源代码生成全面且准确的 API 文档。适用于创建或更新 API 文档、生成 OpenAPI 规范，或在用户提到 API 文档、端点或说明时使用。
$ install --global
skillsauthnpx skillsauth add luongnv89/claude-howto doc-generatorInstall this skill globally with one command. Works with Claude Code, Cursor, and Windsurf.
Security Scan Results
3 of 9 scanners reported clean
Some scanners were skipped, did not run, or reported a non-clean status. Review each row below.
3
Scanners Passed
9
Scanners in report
Clean
TrivyContainer and dependency vulnerability scanner
95%
Clean
SemgrepStatic code analysis for vulnerabilities
95%
Clean
mcp-scan (Snyk)Model Context Protocol security validation
95%
Skipped
Snyk (dep)Open source security scanning
50%
Skipped
Socket.devSupply chain security analysis
50%
Skipped
VirusTotalMulti-engine malware detection
50%
Skipped
CrowdStrikeAdvanced threat intelligence
50%
Skipped
OSV-ScannerOpen Source Vulnerability database check
50%
Skipped
OWASP Dep-Check
50%
Last scanned: Aug 6, 2026, 3:24 AM312.4s1 file scanned
SKILL.md
- name:
- doc-generator
- description:
- 从源代码生成全面且准确的 API 文档。适用于创建或更新 API 文档、生成 OpenAPI 规范，或在用户提到 API 文档、端点或说明时使用。
API 文档生成 Skill
可生成内容
- OpenAPI / Swagger 规范
- API 端点文档
- SDK 使用示例
- 集成指南
- 错误码参考
- 认证指南
文档结构
每个端点的写法
## GET /api/v1/users/:id
### 描述
简要说明这个端点做什么
### 参数
| 名称 | 类型 | 必填 | 说明 |
|------|------|------|------|
| id | string | 是 | 用户 ID |
### 响应
**200 成功**
```json
{
"id": "usr_123",
"name": "John Doe",
"email": "[email protected]",
"created_at": "2025-01-15T10:30:00Z"
}
```
**404 未找到**
```json
{
"error": "USER_NOT_FOUND",
"message": "User does not exist"
}
```
### 示例
**cURL**
```bash
curl -X GET "https://api.example.com/api/v1/users/usr_123" \
-H "Authorization: Bearer YOUR_TOKEN"
```
**JavaScript**
```javascript
const user = await fetch('/api/v1/users/usr_123', {
headers: { 'Authorization': 'Bearer token' }
}).then(r => r.json());
```
**Python**
```python
response = requests.get(
'https://api.example.com/api/v1/users/usr_123',
headers={'Authorization': 'Bearer token'}
)
user = response.json()
```
Related Skills
luongnv89/code-review-specialist
development
VerifiedTrustedCommunity
Comprehensive code review with security, performance, and quality analysis. Use when users ask to review code, analyze code quality, evaluate pull requests, or mention code review, security analysis, or performance optimization.
40,865SKILL.mdUpdated May 27, 2026
luongnv89/ja/03-skills/refactor
development
VerifiedTrustedCommunity
<!-- i18n-source: 03-skills/refactor/SKILL.md --> <!-- i18n-source-sha: 245272f --> <!-- i18n-date: 2026-04-27 --> --- name: refactor description: Martin Fowler の方法論に基づく体系的なコードリファクタリング。ユーザーがコードのリファクタリング、コード構造の改善、技術的負債の削減、レガシーコードのクリーンアップ、コードスメルの解消、コード保守性の向上を求めた際に使用する。本スキルは、リサーチ・計画・安全な段階的実装からなる段階的アプローチを案内する。 --- # コードリファクタリングスキル Martin Fowler 著『Refactoring: Improving the Design of Existing Code』(第 2 版) に基づくコードリファクタリングへの体系的アプローチ。本スキルは、テストに支えられた安全で段階的な変更を重視する。 > "Refactoring is the process of cha
40,865SKILL.mdUpdated Apr 30, 2026
luongnv89/ja/03-skills/doc-generator
development
VerifiedTrustedCommunity
<!-- i18n-source: 03-skills/doc-generator/SKILL.md --> <!-- i18n-source-sha: a6380d8 --> <!-- i18n-date: 2026-04-27 --> --- name: doc-generator description: ソースコードから包括的かつ正確な API ドキュメントを生成する。API ドキュメントの作成・更新、OpenAPI 仕様の生成時、または API ドキュメント、エンドポイント、ドキュメントについて言及がある場合に使用する。 --- # API ドキュメント生成スキル ## 生成するもの - OpenAPI/Swagger 仕様 - API エンドポイントのドキュメント - SDK 利用例 - 統合ガイド - エラーコード・リファレンス - 認証ガイド ## ドキュメント構造 ### 各エンドポイントごと ````markdown ## GET /api/v1/users/:id ### Description このエンドポイントの動作を簡潔に説明 ### Pa
40,865SKILL.mdUpdated Apr 30, 2026
luongnv89/ja/03-skills/claude-md
development
VerifiedTrustedCommunity
<!-- i18n-source: 03-skills/claude-md/SKILL.md --> <!-- i18n-source-sha: f78c094 --> <!-- i18n-date: 2026-04-27 --> --- name: claude-md description: Create or update CLAUDE.md files following best practices for optimal AI agent onboarding --- ## ユーザー入力 ```text $ARGUMENTS ``` ユーザー入力が空でない場合、進める前に **必ず** 内容を考慮すること。ユーザーは以下を指定する場合がある: - `create` - 新しい CLAUDE.md をゼロから作成 - `update` - 既存 CLAUDE.md を改善 - `audit` - 現在の CLAUDE.md の品質を分析しレポート - 作成・更新する具体的なパス（例: ディレクトリ固有命令向けの `src/api/CLAUDE.md`） ## 基本原則
40,865SKILL.mdUpdated Apr 30, 2026