← Back to Skills Marketplace
seanwyngaard

Technical Doc Generator

by Sean Wyngaard · GitHub ↗ · v1.0.0
cross-platform ⚠ suspicious
1133
Downloads
0
Stars
3
Active Installs
1
Versions
Install in OpenClaw
/install technical-doc-generator
Description
Generate professional technical documentation from codebases — API docs, READMEs, architecture diagrams, changelogs, and onboarding guides. Use when writing docs, creating API documentation, or delivering documentation projects.
Usage Guidance
This skill appears coherent and focused on scanning a codebase to produce docs. Before running it: (1) run it only on repositories you control or on a copied/sanitized snapshot — don't point it at / or your home directory; (2) avoid giving it repos that contain secrets or credentials (it may read .env.example or any file in the path); (3) if you want to limit risk, run in a sandboxed environment with no network access so it cannot fetch external resources; (4) verify generated outputs before publishing (it may infer authentication or configuration details that you should confirm). If you need absolute assurance, ask the skill author for explicit required binaries (e.g., git) and a more constrained instruction set.
Capability Analysis
Type: OpenClaw Skill Name: technical-doc-generator Version: 1.0.0 The skill is classified as suspicious primarily due to the explicit inclusion of `Bash` in the `allowed-tools` list within `SKILL.md`. While the instructions themselves do not contain overtly malicious commands or prompt injection attempts, the ability to execute arbitrary shell commands (`Bash`) combined with broad file system access (reading codebases, config files like `.env.example`) presents a significant vulnerability. This capability could be exploited for remote code execution, data exfiltration, or other harmful actions if the agent's behavior is manipulated via prompt injection or if the skill were used by a malicious actor.
Capability Assessment
Purpose & Capability
The name and description (generate README, API docs, architecture, changelog, onboarding) align with the SKILL.md instructions (scan repo files, detect frameworks, parse git history, generate docs). The allowed tools (Read, Write, Edit, Grep, Glob, Bash) are appropriate for repository scanning and document generation.
Instruction Scope
The instructions are focused on files typically found in a codebase (package.json, pyproject.toml, requirements.txt, go.mod, migrations, models, .env.example, LICENSE, git history). They do not instruct reading system config or external secrets. However, the runtime wording is open-ended ('scan the project', 'detect environment variables') and the skill is permitted to run Bash — so the agent could read any files under the provided path. Users should avoid passing overly broad paths (e.g., / or home) or repositories containing secrets.
Install Mechanism
There is no install spec and no code files; this is instruction-only. That minimizes disk writes and third-party downloads. The SKILL.md implies use of repo-local commands (git, parsing package files) but does not require external installers.
Credentials
The skill declares no required environment variables, credentials, or config paths. The documented behavior (detecting env var names used in the code, reading .env.example) is consistent with documentation generation and does not require access to secrets or external credentials.
Persistence & Privilege
The skill is not always-enabled and does not request persistent privileges or modification of other skills. Autonomous invocation is permitted by default but not excessive here; nothing in the manifest indicates it will persist or escalate privileges.
How to Use
  1. Make sure OpenClaw is installed (local or Docker)
  2. Run the install command in chat: /install technical-doc-generator
  3. After installation, invoke the skill by name or use /technical-doc-generator
  4. Provide required inputs per the skill's parameter spec and get structured output
Version History
v1.0.0
Initial release of technical-doc-generator: generate complete technical documentation from codebases. - Supports automated creation of API docs, READMEs, architecture overviews, changelogs, and onboarding guides. - Detects project structure, frameworks, and technologies using codebase scanning. - Outputs documentation files in Markdown, OpenAPI YAML, and Mermaid diagrams. - Organizes generated docs in an output directory for easy client delivery. - Offers both targeted (single doc-type) and full-package documentation generation options.
Metadata
Slug technical-doc-generator
Version 1.0.0
License
All-time Installs 3
Active Installs 3
Total Versions 1
Frequently Asked Questions

What is Technical Doc Generator?

Generate professional technical documentation from codebases — API docs, READMEs, architecture diagrams, changelogs, and onboarding guides. Use when writing docs, creating API documentation, or delivering documentation projects. It is an AI Agent Skill for Claude Code / OpenClaw, with 1133 downloads so far.

How do I install Technical Doc Generator?

Run "/install technical-doc-generator" in the OpenClaw or Claude Code chat to install it in one step — no extra setup required.

Is Technical Doc Generator free?

Yes, Technical Doc Generator is completely free (open-source). You can download, install and use it at no cost.

Which platforms does Technical Doc Generator support?

Technical Doc Generator is cross-platform and runs anywhere OpenClaw / Claude Code is available (cross-platform).

Who created Technical Doc Generator?

It is built and maintained by Sean Wyngaard (@seanwyngaard); the current version is v1.0.0.

💬 Comments