OpenParable
Skip to content
← Back to skills

Docs Init

Documents
docs-init

Docs Init is an Agent Skill for documents published in the majiayu000/claude-skill-registry repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.

(ePost) Scan codebase and generate comprehensive documentation

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/majiayu000/claude-skill-registry/blob/HEAD/skills/documents/docs-init/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/docs-init, 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.

Docs: Init Command

Scan the entire codebase and generate comprehensive documentation files.

Usage

/docs-init

Your Process

1. Scan the Codebase

  • Use Glob to explore directory structure
  • Use Grep to find key patterns (imports, exports, types)
  • Read key files (package.json, tsconfig, configs)
  • Identify: framework, language, database, deployment

2. Generate Documentation Files

Create all files in docs/ directory (create if doesn't exist):

docs/codebase-summary.md

# Codebase Summary

## Project Overview
[What this project does]

## Tech Stack
- [Framework]
- [Language]
- [Database]
- [Deployment]

## Directory Structure

[dir tree]


## Key Files
- `path/to/file` - Description
- `path/to/file` - Description

## Getting Started
- Installation: [commands]
- Development: [commands]
- Build: [commands]

docs/code-standards.md

# Code Standards

## Naming Conventions
- Files: [pattern]
- Variables: [pattern]
- Components: [pattern]

## Code Patterns Found
- [Pattern 1 with examples]
- [Pattern 2 with examples]

## Linting/Formatting
- Tool: [name]
- Config: [location]

## Testing Approach
- Framework: [name]
- Coverage: [target]

docs/system-architecture.md

# System Architecture

## High-Level Overview
[Architecture diagram description]

## Core Modules
- **Module Name** - Purpose
  - Key files: [list]
  - Dependencies: [list]

## Data Flow
[How data moves through the system]

## Key Patterns
- [Pattern used and why]

docs/api-routes.md (if applicable)

# API Routes

## REST Endpoints
| Method | Path | Description | File |
|--------|------|-------------|------|
| GET | /api/... | ... | src/... |

docs/data-models.md (if applicable)

# Data Models

## Database Schema
[Tables/collections and relationships]

## TypeScript Types
[Key types and interfaces]

## State Management
[How state is managed]

docs/deployment-guide.md

# Deployment Guide

## Environment Variables
[Required vars and descriptions]

## Build Process
[Commands and steps]

## Deployment Platforms
- [Platform 1]: [specifics]
- [Platform 2]: [specifics]

## CI/CD
[Pipeline info if found]

3. Save Files

  • Create docs/ directory if needed
  • Write each markdown file
  • Use proper formatting (headings, code blocks, tables)

Analysis Rules

  • Scan EVERYTHING - don't skip directories
  • Look for config files (package.json, tsconfig.json, .env.example)
  • Check for Docker files, CI configs
  • Find test files to understand testing approach
  • Look for README files
  • Examine imports/exports to understand dependencies

Completion

Report:

  • Files created: [count]
  • docs/ directory location
  • Summary of findings (framework, language, patterns)
  • Next steps for the user