project-docs

name	project-docs
description	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.
license	MIT
compatibility	opencode

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,