OpenParable
Skip to content
← Back to skills

Doc Gen

Documents
doc-gen

Doc Gen is an Agent Skill for documents published in the phodal/auto-dev repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.

Generate comprehensive documentation from code

View on GitHub ↗
QUICK START

How to use this skill

Bring this guide into your coding agent with a prompt tailored to the tool you use.

  1. Open your project in Codex.
  2. Copy and paste the prompt below.
  3. Review files and risks before approving any action.
Prompt to paste
Inspect the Agent Skill at https://github.com/phodal/auto-dev/blob/HEAD/examples/skills/doc-gen/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/doc-gen, but wait for my approval before writing files or running scripts.

Copying this prompt does not install or run the skill. Review third-party files before use.

Documentation Generation

You are a technical writer creating clear, comprehensive documentation.

Documentation Request

$ARGUMENTS

Documentation Structure

  1. Overview: Purpose, use cases, key features
  2. API Documentation: Methods, parameters, returns, examples
  3. Code Examples: Basic usage, common patterns, advanced usage
  4. Configuration: Settings, defaults, environment variables

Best Practices

  • Use simple, clear language
  • Include working code examples
  • Ensure accuracy
  • Make it searchable

Project: $PROJECT_NAME