skills.rest
scsm-unrestrict
scsm-unrestrictCOMMUNITY
Explore all skills by this author →
GitHub

project-docs

Generate architecture, API endpoint, and database schema documentation from codebase analysis.

1|Updated Aug 18, 2026
Search Tags:#architecture#documentation#markdown#onboarding#codebase analysis#database schema#api docs
One-click install
npx skills add https://github.com/scsm-unrestrict/dsh-frontend-engineer-agent --skill project-docs-scsm-unrestrict
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: project-docs
Source: https://github.com/scsm-unrestrict/dsh-frontend-engineer-agent/tree/main/frontend-engineer/skills/project-docs
Command: npx skills add https://github.com/scsm-unrestrict/dsh-frontend-engineer-agent --skill project-docs-scsm-unrestrict

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Project documentation is often missing, stale, or written aspirationally rather than reflecting the actual code. This Skill reads source files, routes, schemas, and configs to produce accurate ARCHITECTURE.md, API_ENDPOINTS.md, and DATABASE_SCHEMA.md documents. ## Core Features & Use Cases - Project Type Detection: Scans for indicators like wrangler.toml, vite.config.ts, next.config.js, or drizzle.config.ts to identify the stack before documenting. - Three Doc Templates: Generates ARCHITECTURE.md (stack, directory structure, key flows), API_ENDPOINTS.md (routes, auth, request/response shapes), and DATABASE_SCHEMA.md (tables, relationships, migrations). - Safe Updates: Diffs existing docs against the current codebase and preserves hand-written content instead of silently overwriting it. - Use Case: After a major refactor of a Hono API with a Drizzle database, ask the agent to regenerate API_ENDPOINTS.md and DATABASE_SCHEMA.md so onboarding docs match the real routes and tables. ## Quick Start Ask the agent to generate project documentation by analyzing this codebase and writing ARCHITECTURE.md, API_ENDPOINTS.md, and DATABASE_SCHEMA.md.

Frequently Asked Questions about project-docs

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

FAQPage Schema
How do I generate project documentation from an existing codebase?▼

Ask the agent to generate project docs and it will scan your package.json, entry points, route files, and schema files to detect the stack. It then writes ARCHITECTURE.md, API_ENDPOINTS.md, or DATABASE_SCHEMA.md based on what actually exists in the code.

How to document API endpoints automatically from route files?▼

The Skill reads route files in src/routes or src/api, plus middleware and Zod schemas, to extract methods, params, auth requirements, and response shapes. It writes them into API_ENDPOINTS.md using real TypeScript types rather than guessed formats.

Does it work with frameworks other than Next.js and Hono?▼

Yes, it detects project type from config files including wrangler.toml for Cloudflare Workers, vite.config.ts for React SPAs, astro.config.mjs for Astro, and pyproject.toml or Cargo.toml for Python and Rust projects.

Will it overwrite my existing documentation?▼

No. When docs already exist, it reads them, diffs against the current codebase, shows what changed, and applies updates while preserving hand-written notes. It never silently overwrites custom content.

What are the limitations of generated architecture documentation?▼

The docs only reflect what exists in the code, so undocumented routes or unclear tables are flagged with TODO comments rather than explained. It cannot infer business intent or planned features that are not implemented.

Related Skills

Explore More Software Engineering Skills→
kenlckkenlck
5

ts-codemap

Build a persistent graph of TypeScript/JavaScript files, symbols, and edges.

Community
Advanced
stitts-devstitts-dev

Slack PR Status Message

Generate Slack pull request status messages categorized by review status and mergeability.

Community
Intermediate
open-gitagentopen-gitagent
2.9k

document-review

Automate financial document review for regulatory compliance and balanced presentation.

Official
Advanced
binee108binee108

moai-docs-generation

Generate API references and guides from Python, TypeScript, and JavaScript code.

Community
Intermediate