Skip to content
Back to skills

Doc

ASecurity

Auto-documentation generation - docstrings, architecture guides, API reference

  • 3 stars
  • 0 votes
  • 0 copies
  • 0 views
  • Added October 1, 2026
ai-agentsjavabashapidocumentation

Works with

  • api

Security analysis

A100/100

Scanned October 1, 2026

npx -y skills add sharmapuneet1510/awesome-prompts --skill doc --agent claude-code

Installs into .claude/skills of the current project.

Are you the author of Doc?

Add the live security badge to your README. It updates with every re-scan.

Security grade badge for Doc
[![Security: A — Skills Directory](https://www.skillsdirectory.com/api/skills/sharmapuneet1510-doc/badge)](https://www.skillsdirectory.com/skills/sharmapuneet1510-doc)

More formats (shields.io, HTML) on the badges page. Keep it an A: scan every change in CI with Pro.

Download with Pro
SKILL.md
---
name: doc
description: Auto-documentation generation - docstrings, architecture guides, API reference
argument-hint: path="..."
disable-model-invocation: true
---

Role and rules: read ${CLAUDE_PLUGIN_ROOT}/reference/agent.md and ${CLAUDE_PLUGIN_ROOT}/reference/rules.md for the sections this function needs.

# implementer:doc

**Generate comprehensive documentation** with inline docstrings, architecture guides, and API references.

## Inputs

```
implementer:doc path="..."
```

- `path` (string, required) — Path to source code directory
- `style` (string, optional) — Doc style (javadoc, sphinx, jsdoc)

## Outputs

```
✓ src/                        — Inline docstrings/JSDoc
✓ docs/API.md                 — API reference
✓ docs/ARCHITECTURE.md        — Architecture guide
✓ docs/SETUP.md               — Setup instructions
```

## Example

```bash
implementer:doc path=./src
```

## Workflow

1. Analyze source code
2. Generate inline documentation
3. Create API reference
4. Write architecture guide
5. Generate setup guide
6. Create examples
7. Validate documentation completeness

## Related Functions

- `implementer:full` — Build + test + doc
- `implementer:build` — Code generation

Attribution

Is this your skill, or is something wrong with this listing? Request removal or report an issue. Author removals are honored within 72 hours.

Comments

Loading comments…