← ClaudeAtlas

document-projectlisted

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.
jjmartres/ai-coding-agents · ★ 30 · Data & Documents · score 83
Install: claude install-skill jjmartres/ai-coding-agents
# 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