doc-generate

Generate project documentation from package manifests and code structure.

1|Updated Jan 31, 2026
One-click install
npx skills add https://github.com/allanninal/claude-code-skills --skill doc-generate
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: doc-generate
Source: https://github.com/allanninal/claude-code-skills/tree/main/skills/doc-generate
Command: npx skills add https://github.com/allanninal/claude-code-skills --skill doc-generate

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill automates the creation of essential project documentation, including API references, README files, Claude context files, and setup guides, saving significant developer time and ensuring consistency.

Core Features & Use Cases

  • API Documentation Generation: Creates API endpoint documentation for frameworks like FastAPI and Next.js.
  • README & CLAUDE.md Creation: Generates or updates project overviews, tech stacks, and setup instructions.
  • Setup Guide Generation: Produces detailed, step-by-step instructions for setting up a project.
  • Use Case: When onboarding a new developer to a project, use this Skill to quickly generate a CLAUDE.md file that outlines the project's structure, commands, and key files, enabling them to get up to speed rapidly.

Quick Start

Use the doc-generate skill to create an API documentation file for the current project.

Frequently Asked Questions about doc-generate

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I automatically generate API documentation for FastAPI and Next.js projects?

You can generate API documentation by analyzing project structure and route definitions. This skill parses your codebase to produce comprehensive API references and endpoint documentation for frameworks like FastAPI and Next.js.

What is the best way to create a README and setup guide from an existing codebase?

Creating a README and setup guide is automated by analyzing package manifests like package.json or pyproject.toml. It extracts tech stack details and generates project overviews with step-by-step setup instructions.

Can I generate a CLAUDE.md context file for project onboarding?

Yes, you can generate a CLAUDE.md file to accelerate project onboarding. It outlines the project structure, essential commands, and key files, enabling new developers to understand the codebase rapidly.

Does project documentation generation work with both Python and Node.js environments?

Project documentation generation works with both Python and Node.js environments. It supports frameworks like FastAPI for Python and Next.js for Node.js by analyzing their specific package manifests.

How do code structure analysis tools parse package manifests for documentation?

Code structure analysis tools parse manifests like package.json and pyproject.toml to identify dependencies and scripts. This data is used to generate accurate tech stack overviews and setup guides.

What types of project files are required to generate accurate API references?

Generating accurate API references requires access to your project structure, package manifests, and code files containing route or model definitions. These files provide the necessary context for framework-specific documentation.