sc-document

文档生成技能

针对代码、API 和功能的聚焦文档。

快速入门

# Inline documentation
/sc:document src/auth/login.js --type inline

# API reference
/sc:document src/api --type api --style detailed

# User guide
/sc:document payment-module --type guide

行为流程

1. 分析 - 检查组件结构和功能
2. 确定 - 确定文档要求和受众
3. 生成 - 创建合适的文档内容
4. 格式化 - 应用一致的结构和模式
5. 集成 - 确保与现有文档兼容

标志

标志	类型	默认值	描述
--type	string	inline	inline、external、api、guide
--style	string	detailed	brief、detailed

证据要求

此技能不要求提供确凿证据。交付物包括：

• 生成的文档文件
• 内联代码注释
• API 参考资料

文档类型

内联（--type inline）

• 生成 JSDoc/docstring
• 参数和返回值说明
• 函数级注释

外部（--type external）

• 独立文档文件
• 组件概览
• 集成指南

API（--type api）

• 端点文档
• 请求/响应架构
• 使用示例

指南（--type guide）

• 面向用户的教程
• 实现模式
• 常见用例

风格选项

简洁（--style brief）

• 简洁描述
• 仅包含必要信息
• 快速参考格式

详细（--style detailed）

• 全面说明
• 扩展示例
• 覆盖边缘情况

示例

内联代码文档

/sc:document src/auth/login.js --type inline
# JSDoc with @param, @returns, @throws

API 参考

/sc:document src/api --type api --style detailed
# Full endpoint docs with examples

用户指南

/sc:document payment-module --type guide --style brief
# Quick-start tutorial with common patterns

组件文档

/sc:document components/ --type external
# README.md for component library

MCP 集成

PAL MCP（质量与研究）

工具	使用时机	用途
mcp__pal__codereview	API 文档	检查文档准确性
mcp__pal__apilookup	外部 API	获取最新 API 文档
mcp__pal__chat	写作辅助	获取复杂说明方面的帮助
mcp__pal__consensus	风格决策	通过多模型验证文档方案

PAL 使用模式

# Verify documentation accuracy
mcp__pal__codereview(
    review_type="quick",
    step="Reviewing API documentation for accuracy",
    findings="Parameter descriptions, return types, examples",
    relevant_files=["/docs/api/auth.md"]
)

# Get current API docs for external integration
mcp__pal__apilookup(
    prompt="Get current Stripe API documentation for payment intents"
)

# Writing assistance for complex topics
mcp__pal__chat(
    prompt="Help me explain the OAuth2 authorization code flow clearly for developers",
    model="gpt-5.2"
)

Rube MCP（发布与协作）

工具	使用时机	用途
mcp__rube__RUBE_SEARCH_TOOLS	文档平台	查找 Notion、Confluence、GitBook
mcp__rube__RUBE_MULTI_EXECUTE_TOOL	发布	将文档推送到平台
mcp__rube__RUBE_REMOTE_WORKBENCH	批量文档	为大型代码库生成文档

Rube 使用模式

# Publish documentation
mcp__rube__RUBE_MULTI_EXECUTE_TOOL(tools=[
    {"tool_slug": "NOTION_CREATE_PAGE", "arguments": {
        "title": "API Reference: Authentication",
        "content": "## Endpoints\n### POST /auth/login\n..."
    }},
    {"tool_slug": "CONFLUENCE_CREATE_PAGE", "arguments": {
        "space": "DEV",
        "title": "Auth API Documentation",
        "content": "..."
    }}
])

# Notify team of new docs
mcp__rube__RUBE_MULTI_EXECUTE_TOOL(tools=[
    {"tool_slug": "SLACK_SEND_MESSAGE", "arguments": {
        "channel": "#documentation",
        "text": "New API docs published: Authentication endpoints"
    }}
])

# Bulk generate docs
mcp__rube__RUBE_REMOTE_WORKBENCH(
    thought="Generate JSDoc for all exported functions",
    code_to_execute='''
import os
# Process all JS files and generate documentation
# Use invoke_llm for each function
'''
)

标志（扩展）

标志	类型	默认值	描述
--pal-review	bool	false	使用 PAL 检查文档准确性
--publish	string	-	通过 Rube 发布（notion、confluence、gitbook）
--notify	string	-	通过 Rube 通知（slack、teams、email）

工具协同

• Read - 分析组件
• Grep - 提取引用
• Write - 创建文档
• Glob - 生成多文件文档
• PAL MCP - 准确性检查、API 查询、写作辅助
• Rube MCP - 发布、通知、批量生成