| name | software-manual |
| description | Generate interactive TiddlyWiki-style HTML software manuals with screenshots, API docs, and multi-level code examples. Use when creating user guides, software documentation, or API references. Triggers on "software manual", "user guide", "generate manual", "create docs". |
| allowed-tools | Task, AskUserQuestion, Read, Bash, Glob, Grep, Write, mcp__chrome__* |
Software Manual Skill
Generate comprehensive, interactive software manuals in TiddlyWiki-style single-file HTML format.
Architecture Overview
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
โ Context-Optimized Architecture โ
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโค
โ โ
โ Phase 1: Requirements โ manual-config.json โ
โ โ โ
โ Phase 2: Exploration โ exploration-*.json โ
โ โ โ
โ Phase 3: Parallel Agents โ sections/section-*.md โ
โ โ (6 Agents) โ
โ Phase 3.5: Consolidation โ consolidation-summary.md โ
โ โ โ
โ Phase 4: Screenshot โ screenshots/*.png โ
โ Capture (via Chrome MCP) โ
โ โ โ
โ Phase 5: HTML Assembly โ {name}-ไฝฟ็จๆๅ.html โ
โ โ โ
โ Phase 6: Refinement โ iterations/ โ
โ โ
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
Key Design Principles
- ไธป Agent ็ผๆ๏ผๅญ Agent ๆง่ก: ๆๆ็น้่ฎก็ฎๅงๆ็ป
universal-executor ๅญ Agent
- Brief Returns: Agents return path + summary, not full content (avoid context overflow)
- System Agents: ไฝฟ็จ
cli-explore-agent (ๆข็ดข) ๅ universal-executor (ๆง่ก)
- ๆ็ๅบๅ
ๅต: marked.js (MD ่งฃๆ) + highlight.js (่ฏญๆณ้ซไบฎ)๏ผๆ CDN ไพ่ต
- Single-File HTML: TiddlyWiki-style interactive document with embedded resources
- ๅจๆๆ ็ญพ: ๆ นๆฎๅฎ้
็ซ ่่ชๅจ็ๆๅฏผ่ชๆ ็ญพ
Execution Flow
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
โ Phase 1: Requirements Discovery (ไธป Agent) โ
โ โ AskUserQuestion: ๆถ้่ฝฏไปถ็ฑปๅใ็ฎๆ ็จๆทใๆๆกฃ่ๅด โ
โ โ Output: manual-config.json โ
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโค
โ Phase 2: Project Exploration (cli-explore-agent ร N) โ
โ โ ๅนถ่กๆข็ดข: architecture, ui-routes, api-endpoints, config โ
โ โ Output: exploration-*.json โ
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโค
โ Phase 2.5: API Extraction (extract_apis.py) โ
โ โ ่ชๅจๆๅ: FastAPI/TypeDoc/pdoc โ
โ โ Output: api-docs/{backend,frontend,modules}/*.md โ
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโค
โ Phase 3: Parallel Analysis (universal-executor ร 6) โ
โ โ 6 ไธชๅญ Agent ๅนถ่ก: overview, ui-guide, api-docs, config, โ
โ troubleshooting, code-examples โ
โ โ Output: sections/section-*.md โ
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโค
โ Phase 3.5: Consolidation (universal-executor) โ
โ โ ่ดจ้ๆฃๆฅ: ไธ่ดๆงใไบคๅๅผ็จใๆชๅพๆ ่ฎฐ โ
โ โ Output: consolidation-summary.md, screenshots-list.json โ
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโค
โ Phase 4: Screenshot Capture (universal-executor + Chrome MCP) โ
โ โ ๆน้ๆชๅพ: ่ฐ็จ mcp__chrome__screenshot โ
โ โ Output: screenshots/*.png + manifest.json โ
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโค
โ Phase 5: HTML Assembly (universal-executor) โ
โ โ ็ป่ฃ
HTML: MDโtiddlers, ๅตๅ
ฅ CSS/JS/ๅพ็ โ
โ โ Output: {name}-ไฝฟ็จๆๅ.html โ
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโค
โ Phase 6: Iterative Refinement (ไธป Agent) โ
โ โ ้ข่ง + ็จๆทๅ้ฆ + ่ฟญไปฃไฟฎๅค โ
โ โ Output: iterations/v*.html โ
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
Agent Configuration
| Agent | Role | Output File | Focus Areas |
|---|
| overview | Product Manager | section-overview.md | Product intro, features, quick start |
| ui-guide | UX Expert | section-ui-guide.md | UI operations, step-by-step guides |
| api-docs | API Architect | section-api-reference.md | REST API, Frontend API |
| config | DevOps Engineer | section-configuration.md | Env vars, deployment, settings |
| troubleshooting | Support Engineer | section-troubleshooting.md | FAQs, error codes, solutions |
| code-examples | Developer Advocate | section-examples.md | Beginner/Intermediate/Advanced examples |
Agent Return Format
interface ManualAgentReturn {
status: "completed" | "partial" | "failed";
output_file: string;
summary: string;
screenshots_needed: Array<{
id: string;
url: string;
description: string;
selector?: string;
wait_for?: string;
}>;
cross_references: string[];
difficulty_level: "beginner" | "intermediate" | "advanced";
}
HTML Features (TiddlyWiki-style)
- Search: Full-text search with result highlighting
- Collapse/Expand: Per-section collapsible content
- Tag Navigation: Filter by category tags
- Theme Toggle: Light/Dark mode with localStorage persistence
- Single File: All CSS/JS/images embedded as Base64
- Offline: Works without internet connection
- Print-friendly: Optimized print stylesheet
Directory Setup
const timestamp = new Date().toISOString().slice(0,19).replace(/[-:T]/g, '');
const dir = `.workflow/.scratchpad/manual-${timestamp}`;
Bash(`mkdir "${dir}\\sections" && mkdir "${dir}\\screenshots" && mkdir "${dir}\\api-docs" && mkdir "${dir}\\iterations"`);
Output Structure
.workflow/.scratchpad/manual-{timestamp}/
โโโ manual-config.json # Phase 1
โโโ exploration/ # Phase 2
โ โโโ exploration-architecture.json
โ โโโ exploration-ui-routes.json
โ โโโ exploration-api-endpoints.json
โโโ sections/ # Phase 3
โ โโโ section-overview.md
โ โโโ section-ui-guide.md
โ โโโ section-api-reference.md
โ โโโ section-configuration.md
โ โโโ section-troubleshooting.md
โ โโโ section-examples.md
โโโ consolidation-summary.md # Phase 3.5
โโโ api-docs/ # API documentation
โ โโโ frontend/ # TypeDoc output
โ โโโ backend/ # Swagger/OpenAPI output
โโโ screenshots/ # Phase 4
โ โโโ ss-*.png
โ โโโ screenshots-manifest.json
โโโ iterations/ # Phase 6
โ โโโ v1.html
โ โโโ v2.html
โโโ {่ฝฏไปถๅ}-ไฝฟ็จๆๅ.html # Final Output
Reference Documents
