document-project

Solid

Generate comprehensive, professional project documentation structures including README, ARCHITECTURE, USER_GUIDE, DEVELOPER_GUIDE, and CONTRIBUTING files. Use when the user requests project documentation creation, asks to "document a project", needs standard documentation files, or wants to set up docs for a new repository. Adapts to Python/Go projects and OpenSource/internal contexts.

Data & Documents 48 stars 4 forks Updated today MIT

Install

View on GitHub

Quality Score: 84/100

Stars 20%
56
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# Project Documentation Generator Generate complete, professional documentation structures for software projects. Automatically adapts content and structure based on project language (Python/Go), context (OpenSource/internal), and existing files. ## Core Documentation Files Always generate these five core files: 1. **README.md** - Project overview, quick start, badges 2. **ARCHITECTURE.md** - System design, components, data flow 3. **USER_GUIDE.md** - Usage examples, configuration, troubleshooting 4. **DEVELOPER_GUIDE.md** - Development setup, testing, contribution workflow 5. **CONTRIBUTING.md** - Contribution guidelines, code standards, PR process ## Workflow ### 1. Context Detection Before generating docs, detect: - **Language**: Scan for `go.mod`, `pyproject.toml`, `requirements.txt`, `setup.py` - **Project type**: Check for `Dockerfile`, `terraform/`, `k8s/`, AI/ML indicators - **Existing docs**: Identify what already exists to avoid duplication - **License**: Detect from LICENSE file or ask user - **Context**: Determine if OpenSource or internal based on repo structure ### 2. Ask Clarifying Questions Ask user ONE question at a time to fill gaps: - "What's the primary purpose of this project in one sentence?" - "Who's the main audience? (developers, ops, end-users, all)" - "Is this OpenSource or internal? (affects badges, contact info)" - "Any company-specific tooling to mention? (Jira, Slack channels, etc.)" ### 3. Content Adaptation Read `references/templa...

Details

Author
jjmartres
Repository
jjmartres/ai-coding-agents
Created
5 months ago
Last Updated
today
Language
TypeScript
License
MIT

Integrates with

Similar Skills

Semantically similar based on skill content — not just same category

API & Backend Featured

project-docs

Generate project documentation from codebase analysis — ARCHITECTURE.md, API_ENDPOINTS.md, DATABASE_SCHEMA.md. Reads source code, schema files, routes, and config to produce accurate, structured docs. Use when starting a project, onboarding contributors, or when docs are missing or stale. Triggers: 'generate docs', 'document architecture', 'create api docs', 'document schema', 'project documentation', 'write architecture doc'.

1,031 Updated today
jezweb
AI & Automation Listed

docs

Generate or refresh project documentation (README sections, module docs, usage guides) from the actual code. Use for "document this", "update the README", "write usage docs".

1 Updated 2 months ago
2Tricky4u
Data & Documents Featured

project-documentation

Creates and maintains project documentation for features, systems, and components. Use when documenting how a feature, system, or component works — including writing, updating, or organizing docs. Does not scan or detect the project's technology stack — use project-discovery for repository analysis and config detection. Does not create architectural decision records — use architectural-decision-record for ADRs. Does not create or update coding standards — use coding-standard instead. Does not generate PR descriptions — use update-pr-description for that. Does not produce runbooks for operational scenarios — use runbook for that. Does not rewrite existing prose for readability — use edit-for-readability for that. Does not produce an ephemeral, understand-now overview of code or a PR — use code-overview for that.

273 Updated 2 days ago
testdouble