{ "schemaVersion": "1.0", "item": { "slug": "technical-doc-generator", "name": "Technical Doc Generator", "source": "tencent", "type": "skill", "category": "效率提升", "sourceUrl": "https://clawhub.ai/seanwyngaard/technical-doc-generator", "canonicalUrl": "https://clawhub.ai/seanwyngaard/technical-doc-generator", "targetPlatform": "OpenClaw" }, "install": { "downloadMode": "redirect", "downloadUrl": "/downloads/technical-doc-generator", "sourceDownloadUrl": "https://wry-manatee-359.convex.site/api/v1/download?slug=technical-doc-generator", "sourcePlatform": "tencent", "targetPlatform": "OpenClaw", "installMethod": "Manual import", "extraction": "Extract archive", "prerequisites": [ "OpenClaw" ], "packageFormat": "ZIP package", "includedAssets": [ "SKILL.md" ], "primaryDoc": "SKILL.md", "quickSetup": [ "Download the package from Yavira.", "Extract the archive and review SKILL.md first.", "Import or place the package into your OpenClaw setup." ], "agentAssist": { "summary": "Hand the extracted package to your coding agent with a concrete install brief instead of figuring it out manually.", "steps": [ "Download the package from Yavira.", "Extract it into a folder your agent can access.", "Paste one of the prompts below and point your agent at the extracted folder." ], "prompts": [ { "label": "New install", "body": "I downloaded a skill package from Yavira. Read SKILL.md from the extracted folder and install it by following the included instructions. Tell me what you changed and call out any manual steps you could not complete." }, { "label": "Upgrade existing", "body": "I downloaded an updated skill package from Yavira. Read SKILL.md from the extracted folder, compare it with my current installation, and upgrade it while preserving any custom configuration unless the package docs explicitly say otherwise. Summarize what changed and any follow-up checks I should run." } ] }, "sourceHealth": { "source": "tencent", "status": "healthy", "reason": "direct_download_ok", "recommendedAction": "download", "checkedAt": "2026-04-30T16:55:25.780Z", "expiresAt": "2026-05-07T16:55:25.780Z", "httpStatus": 200, "finalUrl": "https://wry-manatee-359.convex.site/api/v1/download?slug=network", "contentType": "application/zip", "probeMethod": "head", "details": { "probeUrl": "https://wry-manatee-359.convex.site/api/v1/download?slug=network", "contentDisposition": "attachment; filename=\"network-1.0.0.zip\"", "redirectLocation": null, "bodySnippet": null }, "scope": "source", "summary": "Source download looks usable.", "detail": "Yavira can redirect you to the upstream package for this source.", "primaryActionLabel": "Download for OpenClaw", "primaryActionHref": "/downloads/technical-doc-generator" }, "validation": { "installChecklist": [ "Use the Yavira download entry.", "Review SKILL.md after the package is downloaded.", "Confirm the extracted package contains the expected setup assets." ], "postInstallChecks": [ "Confirm the extracted package includes the expected docs or setup files.", "Validate the skill or prompts are available in your target agent workspace.", "Capture any manual follow-up steps the agent could not complete." ] }, "downloadPageUrl": "https://openagent3.xyz/downloads/technical-doc-generator", "agentPageUrl": "https://openagent3.xyz/skills/technical-doc-generator/agent", "manifestUrl": "https://openagent3.xyz/skills/technical-doc-generator/agent.json", "briefUrl": "https://openagent3.xyz/skills/technical-doc-generator/agent.md" }, "agentAssist": { "summary": "Hand the extracted package to your coding agent with a concrete install brief instead of figuring it out manually.", "steps": [ "Download the package from Yavira.", "Extract it into a folder your agent can access.", "Paste one of the prompts below and point your agent at the extracted folder." ], "prompts": [ { "label": "New install", "body": "I downloaded a skill package from Yavira. Read SKILL.md from the extracted folder and install it by following the included instructions. Tell me what you changed and call out any manual steps you could not complete." }, { "label": "Upgrade existing", "body": "I downloaded an updated skill package from Yavira. Read SKILL.md from the extracted folder, compare it with my current installation, and upgrade it while preserving any custom configuration unless the package docs explicitly say otherwise. Summarize what changed and any follow-up checks I should run." } ] }, "documentation": { "source": "clawhub", "primaryDoc": "SKILL.md", "sections": [ { "title": "Technical Documentation Generator", "body": "Scan a codebase and generate client-deliverable technical documentation. Produces API docs, READMEs, architecture overviews, changelogs, and developer onboarding guides." }, { "title": "How to Use", "body": "/technical-doc-generator ./src api-docs\n/technical-doc-generator . full\n/technical-doc-generator ./src readme\n/technical-doc-generator . changelog\n/technical-doc-generator ./src onboarding\n\n$ARGUMENTS[0] = Path to codebase (default: current directory)\n$ARGUMENTS[1] = Doc type: api-docs, readme, architecture, changelog, onboarding, full (all)" }, { "title": "readme — Project README", "body": "Scan the project and generate a comprehensive README:\n\n# Project Name\n\nBrief description (1-2 sentences from package.json, pyproject.toml, or code analysis).\n\n## Features\n- [Auto-detected from code structure]\n\n## Quick Start\n\n### Prerequisites\n[Detected from package.json, requirements.txt, go.mod, etc.]\n\n### Installation\n[Generated from detected package manager and config files]\n\n### Configuration\n[Detected from .env.example, config files, environment variables in code]\n\n### Usage\n[Basic usage examples from entry points, CLI args, or main functions]\n\n## Project Structure\n[Generated directory tree with descriptions]\n\n## API Reference\n[Brief overview with link to full docs if generated]\n\n## Contributing\n[Standard contributing section]\n\n## License\n[Detected from LICENSE file]" }, { "title": "api-docs — API Documentation", "body": "Scan for API endpoints and generate documentation:\n\nDetect the framework: Express, FastAPI, Django, Flask, Rails, Spring, Gin, etc.\nExtract endpoints: Routes, methods, parameters, request/response bodies\nGenerate OpenAPI/Swagger spec (YAML)\nGenerate human-readable docs (Markdown)\n\nFor each endpoint:\n\n### `POST /api/users`\n\nCreate a new user account.\n\n**Authentication**: Required (Bearer token)\n\n**Request Body**:\n| Field | Type | Required | Description |\n|-------|------|----------|-------------|\n| email | string | Yes | User's email address |\n| name | string | Yes | Full name |\n| role | string | No | User role (default: \"member\") |\n\n**Example Request**:\n```json\n{\n \"email\": \"user@example.com\",\n \"name\": \"Jane Doe\",\n \"role\": \"admin\"\n}\n\nResponse (201 Created):\n\n{\n \"id\": \"usr_abc123\",\n \"email\": \"user@example.com\",\n \"name\": \"Jane Doe\",\n \"role\": \"admin\",\n \"created_at\": \"2026-02-13T10:00:00Z\"\n}\n\nError Responses:\n\nStatusDescription400Invalid request body409Email already exists401Missing or invalid auth token\n\n### `architecture` — Architecture Overview\n\nGenerate an architecture document with:\n\n1. **System overview**: What the system does, high-level description\n2. **Technology stack**: Languages, frameworks, databases, services detected\n3. **Directory structure**: Annotated tree with purpose of each directory\n4. **Component diagram**: Mermaid diagram showing major components and their relationships\n5. **Data flow**: How data moves through the system\n6. **Database schema**: If migrations or models are found, document the schema\n7. **External dependencies**: Third-party services, APIs, databases\n8. **Configuration**: Environment variables and their purposes\n\nMermaid diagram example:\n```mermaid\ngraph TB\n Client[Client App] --> API[API Server]\n API --> Auth[Auth Service]\n API --> DB[(PostgreSQL)]\n API --> Cache[(Redis)]\n API --> Queue[Job Queue]\n Queue --> Worker[Background Worker]\n Worker --> DB\n Worker --> Email[Email Service]" }, { "title": "changelog — Changelog from Git History", "body": "Parse git log and generate a structured changelog:\n\n# Changelog\n\n## [Unreleased]\n### Added\n- [Features from commits since last tag]\n\n### Changed\n- [Modifications]\n\n### Fixed\n- [Bug fixes]\n\n## [1.2.0] - 2026-02-10\n### Added\n- ...\n\nRules:\n\nGroup by semantic version tags (or by month if no tags)\nCategorize commits: Added, Changed, Fixed, Removed, Security, Deprecated\nParse conventional commits if used (feat:, fix:, chore:, etc.)\nSkip merge commits and build/CI commits\nLink to PRs/issues if references found in commit messages" }, { "title": "onboarding — Developer Onboarding Guide", "body": "Generate a guide for new developers joining the project:\n\n# Developer Onboarding Guide\n\n## Prerequisites\n[Required software, versions, accounts]\n\n## Getting Started\n### 1. Clone and Setup\n[Step-by-step with exact commands]\n\n### 2. Environment Configuration\n[All env vars explained with example values]\n\n### 3. Run Locally\n[Commands to start the dev server, run tests, etc.]\n\n### 4. Verify Setup\n[How to confirm everything is working]\n\n## Codebase Tour\n### Architecture Overview\n[Brief system description with diagram]\n\n### Key Directories\n[What lives where and why]\n\n### Important Files\n[Config files, entry points, key modules]\n\n## Development Workflow\n### Branching Strategy\n[Detected from git history or standard gitflow]\n\n### Running Tests\n[Test commands, test structure]\n\n### Code Style\n[Linting config, formatting tools detected]\n\n### Making Changes\n[Typical workflow: branch → code → test → PR]\n\n## Common Tasks\n### Add a new API endpoint\n[Step-by-step based on existing patterns]\n\n### Add a database migration\n[Based on detected ORM/migration tool]\n\n### Deploy\n[If deployment config is detected]\n\n## Troubleshooting\n### Common Issues\n[Based on README, issues, or common patterns]" }, { "title": "full — Complete Documentation Package", "body": "Generate ALL of the above, organized in a docs/ directory:\n\ndocs/\n README.md # Project README (also copy to project root if none exists)\n API.md # API documentation\n ARCHITECTURE.md # Architecture overview\n CHANGELOG.md # Changelog\n ONBOARDING.md # Developer onboarding\n openapi.yaml # OpenAPI spec (if API detected)\n diagrams/ # Mermaid source files" }, { "title": "Codebase Scanning Strategy", "body": "Package files first: package.json, pyproject.toml, go.mod, Cargo.toml, Gemfile, pom.xml\nConfig files: .env.example, docker-compose.yml, CI/CD configs\nEntry points: main.*, index.*, app.*, server.*\nRoute/endpoint files: Files containing route definitions\nModels/schemas: Database models, TypeScript interfaces, Pydantic models\nTest files: To understand expected behavior\nExisting docs: Any existing README, docs/, wiki content\n\nDo NOT read every file. Be strategic — scan structure first, then dive into key files." }, { "title": "Output", "body": "Save all generated docs to output/docs/ (or docs/ if specified). Present a summary of what was generated and suggest next steps for the client." } ], "body": "Technical Documentation Generator\n\nScan a codebase and generate client-deliverable technical documentation. Produces API docs, READMEs, architecture overviews, changelogs, and developer onboarding guides.\n\nHow to Use\n/technical-doc-generator ./src api-docs\n/technical-doc-generator . full\n/technical-doc-generator ./src readme\n/technical-doc-generator . changelog\n/technical-doc-generator ./src onboarding\n\n$ARGUMENTS[0] = Path to codebase (default: current directory)\n$ARGUMENTS[1] = Doc type: api-docs, readme, architecture, changelog, onboarding, full (all)\nDocumentation Types\nreadme — Project README\n\nScan the project and generate a comprehensive README:\n\n# Project Name\n\nBrief description (1-2 sentences from package.json, pyproject.toml, or code analysis).\n\n## Features\n- [Auto-detected from code structure]\n\n## Quick Start\n\n### Prerequisites\n[Detected from package.json, requirements.txt, go.mod, etc.]\n\n### Installation\n[Generated from detected package manager and config files]\n\n### Configuration\n[Detected from .env.example, config files, environment variables in code]\n\n### Usage\n[Basic usage examples from entry points, CLI args, or main functions]\n\n## Project Structure\n[Generated directory tree with descriptions]\n\n## API Reference\n[Brief overview with link to full docs if generated]\n\n## Contributing\n[Standard contributing section]\n\n## License\n[Detected from LICENSE file]\n\napi-docs — API Documentation\n\nScan for API endpoints and generate documentation:\n\nDetect the framework: Express, FastAPI, Django, Flask, Rails, Spring, Gin, etc.\nExtract endpoints: Routes, methods, parameters, request/response bodies\nGenerate OpenAPI/Swagger spec (YAML)\nGenerate human-readable docs (Markdown)\n\nFor each endpoint:\n\n### `POST /api/users`\n\nCreate a new user account.\n\n**Authentication**: Required (Bearer token)\n\n**Request Body**:\n| Field | Type | Required | Description |\n|-------|------|----------|-------------|\n| email | string | Yes | User's email address |\n| name | string | Yes | Full name |\n| role | string | No | User role (default: \"member\") |\n\n**Example Request**:\n```json\n{\n \"email\": \"user@example.com\",\n \"name\": \"Jane Doe\",\n \"role\": \"admin\"\n}\n\n\nResponse (201 Created):\n\n{\n \"id\": \"usr_abc123\",\n \"email\": \"user@example.com\",\n \"name\": \"Jane Doe\",\n \"role\": \"admin\",\n \"created_at\": \"2026-02-13T10:00:00Z\"\n}\n\n\nError Responses:\n\nStatus\tDescription\n400\tInvalid request body\n409\tEmail already exists\n401\tMissing or invalid auth token\n\n### `architecture` — Architecture Overview\n\nGenerate an architecture document with:\n\n1. **System overview**: What the system does, high-level description\n2. **Technology stack**: Languages, frameworks, databases, services detected\n3. **Directory structure**: Annotated tree with purpose of each directory\n4. **Component diagram**: Mermaid diagram showing major components and their relationships\n5. **Data flow**: How data moves through the system\n6. **Database schema**: If migrations or models are found, document the schema\n7. **External dependencies**: Third-party services, APIs, databases\n8. **Configuration**: Environment variables and their purposes\n\nMermaid diagram example:\n```mermaid\ngraph TB\n Client[Client App] --> API[API Server]\n API --> Auth[Auth Service]\n API --> DB[(PostgreSQL)]\n API --> Cache[(Redis)]\n API --> Queue[Job Queue]\n Queue --> Worker[Background Worker]\n Worker --> DB\n Worker --> Email[Email Service]\n\nchangelog — Changelog from Git History\n\nParse git log and generate a structured changelog:\n\n# Changelog\n\n## [Unreleased]\n### Added\n- [Features from commits since last tag]\n\n### Changed\n- [Modifications]\n\n### Fixed\n- [Bug fixes]\n\n## [1.2.0] - 2026-02-10\n### Added\n- ...\n\n\nRules:\n\nGroup by semantic version tags (or by month if no tags)\nCategorize commits: Added, Changed, Fixed, Removed, Security, Deprecated\nParse conventional commits if used (feat:, fix:, chore:, etc.)\nSkip merge commits and build/CI commits\nLink to PRs/issues if references found in commit messages\nonboarding — Developer Onboarding Guide\n\nGenerate a guide for new developers joining the project:\n\n# Developer Onboarding Guide\n\n## Prerequisites\n[Required software, versions, accounts]\n\n## Getting Started\n### 1. Clone and Setup\n[Step-by-step with exact commands]\n\n### 2. Environment Configuration\n[All env vars explained with example values]\n\n### 3. Run Locally\n[Commands to start the dev server, run tests, etc.]\n\n### 4. Verify Setup\n[How to confirm everything is working]\n\n## Codebase Tour\n### Architecture Overview\n[Brief system description with diagram]\n\n### Key Directories\n[What lives where and why]\n\n### Important Files\n[Config files, entry points, key modules]\n\n## Development Workflow\n### Branching Strategy\n[Detected from git history or standard gitflow]\n\n### Running Tests\n[Test commands, test structure]\n\n### Code Style\n[Linting config, formatting tools detected]\n\n### Making Changes\n[Typical workflow: branch → code → test → PR]\n\n## Common Tasks\n### Add a new API endpoint\n[Step-by-step based on existing patterns]\n\n### Add a database migration\n[Based on detected ORM/migration tool]\n\n### Deploy\n[If deployment config is detected]\n\n## Troubleshooting\n### Common Issues\n[Based on README, issues, or common patterns]\n\nfull — Complete Documentation Package\n\nGenerate ALL of the above, organized in a docs/ directory:\n\ndocs/\n README.md # Project README (also copy to project root if none exists)\n API.md # API documentation\n ARCHITECTURE.md # Architecture overview\n CHANGELOG.md # Changelog\n ONBOARDING.md # Developer onboarding\n openapi.yaml # OpenAPI spec (if API detected)\n diagrams/ # Mermaid source files\n\nCodebase Scanning Strategy\nPackage files first: package.json, pyproject.toml, go.mod, Cargo.toml, Gemfile, pom.xml\nConfig files: .env.example, docker-compose.yml, CI/CD configs\nEntry points: main.*, index.*, app.*, server.*\nRoute/endpoint files: Files containing route definitions\nModels/schemas: Database models, TypeScript interfaces, Pydantic models\nTest files: To understand expected behavior\nExisting docs: Any existing README, docs/, wiki content\n\nDo NOT read every file. Be strategic — scan structure first, then dive into key files.\n\nOutput\n\nSave all generated docs to output/docs/ (or docs/ if specified). Present a summary of what was generated and suggest next steps for the client." }, "trust": { "sourceLabel": "tencent", "provenanceUrl": "https://clawhub.ai/seanwyngaard/technical-doc-generator", "publisherUrl": "https://clawhub.ai/seanwyngaard/technical-doc-generator", "owner": "seanwyngaard", "version": "1.0.0", "license": null, "verificationStatus": "Indexed source record" }, "links": { "detailUrl": "https://openagent3.xyz/skills/technical-doc-generator", "downloadUrl": "https://openagent3.xyz/downloads/technical-doc-generator", "agentUrl": "https://openagent3.xyz/skills/technical-doc-generator/agent", "manifestUrl": "https://openagent3.xyz/skills/technical-doc-generator/agent.json", "briefUrl": "https://openagent3.xyz/skills/technical-doc-generator/agent.md" } }