菜单
Enhanced docs generation with AI-powered features. Enhanced with Context7 MCP for up-to-date documentation.
默认使用会先检查来源的 Prompt；你也可以切换为直接命令，或下载本地副本。
决定是否安装前，请先阅读 SKILL.md，以及 SkillsMP 当前展示的配套文件。
用 Codex 或 Claude 帮你安装 复制这段 Prompt，粘贴到 Codex、Claude 或其他助手里，让它检查 Skill 页面并帮你完成安装。
直接命令不会经过审查 Prompt；运行前请先检查来源。
npx skills add https://github.com/AJBcoding/claude-skill-eval --skill moai-docs-generation命令会保持在同一行。复制前请横向滚动并检查完整内容。
想先保存到本地？可下载 SkillsMP 当前能够提供的文件。
Enterprise database architecture specialist with PostgreSQL 17, MySQL 8.4 LTS, MongoDB 8.0, Redis 7.4 expertise. Master connection pooling, query optimization, caching strategies, and database DevOps automation. Build scalable, resilient database systems with comprehensive monitoring and disaster recovery.
Enterprise Frontend Development with AI-powered modern architecture, Context7 integration, and intelligent component orchestration for scalable user interfaces
Enterprise-grade security expertise with production-ready patterns for OWASP Top 10 2021, zero-trust architecture, threat modeling (STRIDE, PASTA), secure SDLC, DevSecOps automation, cloud security, cryptography, identity & access management, and compliance frameworks (SOC 2, ISO 27001, GDPR, CCPA).
基于 SOC 职业分类
正在显示 SKILL.md
| name | moai-docs-generation |
| version | 4.0.0 |
| created | 2025-11-12T00:00:00.000Z |
| updated | 2025-11-12T00:00:00.000Z |
| status | stable |
| tier | specialization |
| description | Enhanced docs generation with AI-powered features. Enhanced with Context7 MCP for up-to-date documentation. |
| allowed-tools | Read, Glob, Grep, WebSearch, WebFetch, mcp__context7__resolve-library-id, mcp__context7__get-library-docs |
| primary-agent | doc-syncer |
| secondary-agents | ["alfred"] |
| keywords | ["docs","generation","test","api","spec"] |
| tags | ["documentation"] |
| orchestration | null |
| can_resume | true |
| typical_chain_position | terminal |
| depends_on | [] |
Docs Generation
Primary Agent: doc-syncer
Secondary Agents: alfred
Version: 4.0.0
Keywords: docs, generation, test, api, spec
Overview Brief description of what this guide covers.
Metadata
skill_id: moai-docs-generation
skill_name: Documentation Generation & Template Management
version: 1.0.0
created_date: 2025-11-10
updated_date: 2025-11-10
language: english
word_count: 1400
triggers:
- keywords: [documentation generation, doc template, scaffold, generate docs, api documentation, readme generation]
- contexts: [docs-generation, @docs:generate, documentation-template, doc-scaffold]
agents:
- docs-manager
-
Step-by-Step Tutorial
Detailed explanation...
code-example
...
Usage
Signature: ```typescript function methodName(param1: Type1, param2: Type2): ReturnType ```
Parameters:
| Name | Type | Description |
|---|---|---|
| param1 | Type1 | What it does |
Returns: Description of return value
Example: ```typescript const result = methodName(arg1, arg2); ```
Throws: Possible exceptions
Examples
...
...
Core Concepts
Explanation with examples.
Explanation with examples.
License License Type
### Section 3: Scaffold Generation
**Directory Structure Generation**:
```python
class DocumentationScaffold:
def __init__(self, project_name: str):
self.project_name = project_name
def create_guide_structure(self, guide_name: str) -> None:
"""Create guide directory and template files"""
guide_dir = Path(f"docs/guides/{guide_name}")
guide_dir.mkdir(parents=True, exist_ok=True)
# Create index.md with guide template
index_path = guide_dir / "index.md"
index_path.write_text(GUIDE_TEMPLATE)
# Create subdirectories
(guide_dir / "examples").mkdir(exist_ok=True)
(guide_dir / "images").mkdir(exist_ok=True)
(guide_dir / "code-samples").mkdir(exist_ok=True)
def create_api_docs(self, module_name: str) -> None:
"""Generate API documentation structure"""
api_dir = Path(f"docs/api/{module_name}")
api_dir.mkdir(parents=True, exist_ok=True)
# Create main API doc
api_path = api_dir / "index.md"
api_path.write_text(API_TEMPLATE)
def create_multilingual_structure(self, doc_name: str) -> None:
"""Create docs in ko/, en/, ja/, zh/"""
for lang in ["ko", "en", "ja", "zh"]:
doc_dir = Path(f"docs/src/{lang}/{doc_name}")
doc_dir.mkdir(parents=True, exist_ok=True)
doc_path = doc_dir / "index.md"
doc_path.write_text(self._get_template_for_lang(lang))
TypeScript/JavaScript:
/**
* Calculate sum of two numbers
* @param a First number
* @param b Second number
* @returns Sum of a and b
* @example
* const result = sum(2, 3); // Returns 5
*/
function sum(a: number, b: number): number {
return a + b;
}
Generate documentation:
### Function: sum
Calculate sum of two numbers
**Signature**:
```typescript
function sum(a: number, b: number): number
Parameters:
a: First numberb: Second numberReturns: Sum of a and b
Example:
const result = sum(2, 3); // Returns 5
**Python**:
```python
def calculate_mean(numbers: List[float]) -> float:
"""
Calculate arithmetic mean of numbers.
Args:
numbers: List of numerical values
Returns:
Arithmetic mean of the values
Raises:
ValueError: If list is empty
Example:
>>> calculate_mean([1, 2, 3])
2.0
"""
if not numbers:
raise ValueError("Cannot calculate mean of empty list")
return sum(numbers) / len(numbers)
Generate all project documentation:
# Generate README for each module
/docs:generate --type readme --scope all
# Generate API documentation from code
/docs:generate --type api --language typescript
# Create guides for new features
/docs:generate --type guide --feature-spec SPEC-001
# Generate multilingual structure
/docs:generate --type i18n --languages ko,en,ja,zh
✅ Validation Checklist
Note: Advanced patterns for complex scenarios.
Coming soon: Deep dive into expert-level usage.
Must-Have:
Recommended:
Security:
When to Use Context7 for This Skill:
This skill benefits from Context7 when:
Example Usage:
# Fetch latest documentation
from moai_adk.integrations import Context7Helper
helper = Context7Helper()
docs = await helper.get_docs(
library_id="/org/library",
topic="docs",
tokens=5000
)
Relevant Libraries:
| Library | Context7 ID | Use Case |
|---|---|---|
| [Library 1] | /org/lib1 | [When to use] |
When to use moai-docs-generation:
Start
├─ Need docs?
│ ├─ YES → Use this skill
│ └─ NO → Consider alternatives
└─ Complex scenario?
├─ YES → See Level 3
└─ NO → Start with Level 1
Prerequisite Skills:
Complementary Skills:
Next Steps:
Metadata
skill_id: moai-docs-generation
skill_name: Documentation Generation & Template Management
version: 1.0.0
created_date: 2025-11-10
updated_date: 2025-11-10
language: english
word_count: 1400
triggers:
- keywords: [documentation generation, doc template, scaffold, generate docs, api documentation, readme generation]
- contexts: [docs-generation, @docs:generate, documentation-template, doc-scaffold]
agents:
- docs-manager
- spec-builder
- frontend-expert
- backend-expert
freedom_level: high
context7_references:
- url: "https://www.typescriptlang.org/docs/handbook/"
topic: "TypeScript Documentation Pattern"
- url: "https://github.com/prettier/prettier"
topic: "Code Formatting Standards"
v4.0.0 (2025-11-12)
Generated with: MoAI-ADK Skill Factory v4.0
Last Updated: 2025-11-12
Maintained by: Primary Agent (doc-syncer)