Auto-documentation generator — analyzes code and generates README, API docs, architecture docs, inline comments. Use when documentation is missing or outdated.
Version: 1.1.0 | Author: Shadows Company | License: MIT
No binaries required. This skill reads source files and generates documentation in markdown format. No external tools needed.
Structure:
# Project Name
[One-line description]
## Quick Start
[3-5 steps to get running]
## Features
[Bullet list of key capabilities]
## Installation
[Step-by-step install instructions]
## Usage
[Code examples for common use cases]
## Configuration
[Environment variables, config files]
## API Reference
[If applicable — endpoints or function signatures]
## Architecture
[High-level diagram or description]
## Contributing
[How to contribute]
## License
[License type]
For each endpoint/function:
### `METHOD /path/to/endpoint`
**Description**: What it does.
**Auth**: Required/Optional/None
**Parameters**:
| Name | Type | Required | Description |
|------|------|----------|-------------|
| id | string | Yes | Resource ID |
**Request Body**:
```json
{ "key": "value" }
Response (200):
{ "ok": true, "data": {} }
Errors:
| Code | Description |
|---|---|
| 400 | Invalid input |
| 401 | Unauthorized |
| 404 | Not found |
### Type 3 — Architecture Document
```markdown
# Architecture Overview
## System Diagram
[Text-based diagram using ASCII or Mermaid]
## Components
[Description of each major component]
## Data Flow
[How data moves through the system]
## Key Decisions
[Why certain architectural choices were made]
## Dependencies
[External services and their purposes]
Rules for adding code comments:
// increment counter on counter++ is noiseGood:
# Rate limit: Stripe API allows max 100 requests/sec.
# We batch to stay under 80 to account for retries.
batch_size = 80
Bad:
# Set batch size to 80
batch_size = 80
This skill reads source code files to generate documentation. It does not execute code, make network calls, or modify existing source files. Generated documentation is written as new files only. No credentials required, no persistence, no network access. Safe for all repositories.
Generated documentation follows the templates defined in DOCUMENTATION TYPES above. Each output file is a standalone markdown document placed alongside the source it documents (or at the project root for README.md).
Published by Shadows Company — "We work in the shadows to serve the Light."
ZIP package — ready to use