Files
Claude-Code-Workflow/.claude/skills/software-manual/phases/03-parallel-analysis.md
catlog22 169f218f7a feat(discovery): enhance discovery index reading and issue exporting
- Improved the reading of the discovery index by adding a fallback mechanism to scan directories for discovery folders if the index.json is invalid or missing.
- Added sorting of discoveries by creation time in descending order.
- Enhanced the `appendToIssuesJsonl` function to include deduplication logic for issues based on ID and source finding ID.
- Updated the discovery route handler to reflect the number of issues added and skipped during export.
- Introduced UI elements for selecting and deselecting findings in the dashboard.
- Added CSS styles for exported findings and action buttons.
- Implemented search functionality for filtering findings based on title, file, and description.
- Added internationalization support for new UI elements.
- Created scripts for automated API extraction from various project types, including FastAPI and TypeScript.
- Documented the API extraction process and library bundling instructions.
2025-12-28 19:27:34 +08:00

5.4 KiB
Raw Blame History

Phase 3: Parallel Analysis

使用 universal-executor 并行生成 6 个文档章节。

Agent 配置

const AGENT_CONFIGS = {
  overview: {
    role: 'Product Manager',
    output: 'section-overview.md',
    task: '撰写产品概览、核心功能、快速入门指南',
    focus: '产品定位、目标用户、5步快速入门、系统要求',
    input: ['exploration-architecture.json', 'README.md', 'package.json'],
    tag: 'getting-started'
  },
  'interface-guide': {
    role: 'Product Designer',
    output: 'section-interface.md',
    task: '撰写界面或交互指南Web 截图、CLI 命令交互、桌面应用操作)',
    focus: '视觉布局、交互流程、命令行参数、输入/输出示例',
    input: ['exploration-ui-routes.json', 'src/**', 'pages/**', 'views/**', 'components/**', 'src/commands/**'],
    tag: 'interface',
    screenshot_rules: `
根据项目类型标注交互点:

[Web] <!-- SCREENSHOT: id="ss-{功能}" url="{路由}" selector="{CSS选择器}" description="{描述}" -->
[CLI] 使用代码块展示命令交互:
\`\`\`bash
$ command --flag value
Expected output here
\`\`\`
[Desktop] <!-- SCREENSHOT: id="ss-{功能}" description="{描述}" -->
`
  },
  'api-reference': {
    role: 'Technical Architect',
    output: 'section-reference.md',
    task: '撰写接口参考文档REST API / 函数库 / CLI 命令)',
    focus: '函数签名、端点定义、参数说明、返回值、错误代码',
    pre_extract: 'python .claude/skills/software-manual/scripts/extract_apis.py -o ${workDir}',
    input: [
      '${workDir}/api-docs/backend/openapi.json',     // FastAPI OpenAPI
      '${workDir}/api-docs/backend/API_SUMMARY.md',   // Backend summary
      '${workDir}/api-docs/frontend/**/*.md',         // TypeDoc output
      '${workDir}/api-docs/hydro_generator/**/*.md',  // Python module
      '${workDir}/api-docs/multiphysics/**/*.md'      // Python module
    ],
    tag: 'api'
  },
  config: {
    role: 'DevOps Engineer',
    output: 'section-configuration.md',
    task: '撰写配置指南,涵盖环境变量、配置文件、部署设置',
    focus: '环境变量表格、配置文件格式、部署选项、安全设置',
    input: ['exploration-config.json', '.env.example', 'config/**', '*.config.*'],
    tag: 'config'
  },
  troubleshooting: {
    role: 'Support Engineer',
    output: 'section-troubleshooting.md',
    task: '撰写故障排查指南涵盖常见问题、错误码、FAQ',
    focus: '常见问题与解决方案、错误码参考、FAQ、获取帮助',
    input: ['docs/troubleshooting.md', 'src/**/errors.*', 'src/**/exceptions.*', 'TROUBLESHOOTING.md'],
    tag: 'troubleshooting'
  },
  'code-examples': {
    role: 'Developer Advocate',
    output: 'section-examples.md',
    task: '撰写多难度级别代码示例入门40%/进阶40%/高级20%',
    focus: '完整可运行代码、分步解释、预期输出、最佳实践',
    input: ['examples/**', 'tests/**', 'demo/**', 'samples/**'],
    tag: 'examples'
  }
};

执行流程

const config = JSON.parse(Read(`${workDir}/manual-config.json`));

// 1. 预提取 API 文档(如有 pre_extract 配置)
for (const [name, cfg] of Object.entries(AGENT_CONFIGS)) {
  if (cfg.pre_extract) {
    const cmd = cfg.pre_extract.replace(/\$\{workDir\}/g, workDir);
    console.log(`[Pre-extract] ${name}: ${cmd}`);
    Bash({ command: cmd });
  }
}

// 2. 并行启动 6 个 universal-executor
const tasks = Object.entries(AGENT_CONFIGS).map(([name, cfg]) =>
  Task({
    subagent_type: 'universal-executor',
    run_in_background: false,
    prompt: buildAgentPrompt(name, cfg, config, workDir)
  })
);

const results = await Promise.all(tasks);

Prompt 构建

function buildAgentPrompt(name, cfg, config, workDir) {
  const screenshotSection = cfg.screenshot_rules
    ? `\n[SCREENSHOT RULES]\n${cfg.screenshot_rules}`
    : '';

  return `
[ROLE] ${cfg.role}

[PROJECT CONTEXT]
项目类型: ${config.software.type} (web/cli/sdk/desktop)
语言: ${config.software.language || 'auto-detect'}
名称: ${config.software.name}

[TASK]
${cfg.task}
输出: ${workDir}/sections/${cfg.output}

[INPUT]
- 配置: ${workDir}/manual-config.json
- 探索结果: ${workDir}/exploration/
- 扫描路径: ${cfg.input.join(', ')}

[CONTENT REQUIREMENTS]
- 标题层级: # ## ### (最多3级)
- 代码块: \`\`\`language ... \`\`\` (必须标注语言)
- 表格: | col1 | col2 | 格式
- 列表: 有序 1. 2. 3. / 无序 - - -
- 内联代码: \`code\`
- 链接: [text](url)
${screenshotSection}

[FOCUS]
${cfg.focus}

[OUTPUT FORMAT]
Markdown 文件,包含:
- 清晰的章节结构
- 具体的代码示例
- 参数/配置表格
- 常见用例说明

[RETURN JSON]
{
  "status": "completed",
  "output_file": "sections/${cfg.output}",
  "summary": "<50字>",
  "tag": "${cfg.tag}",
  "screenshots_needed": []
}
`;
}

结果收集

const agentResults = results.map(r => JSON.parse(r));
const allScreenshots = agentResults.flatMap(r => r.screenshots_needed);

Write(`${workDir}/agent-results.json`, JSON.stringify({
  results: agentResults,
  screenshots_needed: allScreenshots,
  timestamp: new Date().toISOString()
}, null, 2));

质量检查

  • Markdown 语法有效
  • 无占位符文本
  • 代码块标注语言
  • 截图标记格式正确
  • 交叉引用有效

下一阶段

Phase 3.5: Consolidation