- Generate full documentation suite - README, CONTRIBUTING, CODE_OF_CONDUCT, CHANGELOG, architecture, API docs
- Generate a single document - Create or replace one specific document
- Update existing documentation - Refresh docs based on code changes
- Audit documentation - Check what's missing or outdated
Wait for response before proceeding.
After reading the workflow, follow it exactly.
Styling: github-styling.md (badges, emoji, collapsible sections, modern conventions)
Document Types: doc-types.md (what each document should contain, best practices)
Code Analysis: code-analysis.md (how to extract info from source files)
| Template |
Purpose |
| readme-template.md |
Modern README with all sections |
| contributing-template.md |
Contribution guidelines |
| code-of-conduct-template.md |
Community standards |
| changelog-template.md |
Version history format |
| architecture-template.md |
System design documentation |
| api-docs-template.md |
API reference format |
|
|
1---2name: create-project-docs3description: Creates comprehensive GitHub project documentation including README, CONTRIBUTING, CODE_OF_CONDUCT, CHANGELOG, architecture docs, and API documentation. Analyzes codebase to generate accurate, well-styled documentation with modern GitHub aesthetics. Use when setting up a new project, improving existing documentation, or generating missing docs.4---5
6<essential_principles>
7
8<principle name="code-first-documentation">
9Always analyze the actual codebase before writing documentation. Read source files, understand project structure, extract function signatures, and infer purpose from code. Never write documentation based on assumptions.
10</principle>
11
12<principle name="aesthetic-consistency">
13All documentation follows modern GitHub conventions:
14- Badges at top of README (build status, version, license, coverage)
15- Table of contents for documents > 100 lines
16- Collapsible sections for verbose content using `<details>`
17- Emoji as section markers (use sparingly, consistently)
18- Proper heading hierarchy (never skip levels)
19- Code blocks with language identifiers
20</principle>
21
22<principle name="practical-examples">
23Every feature documented must include a working example. Examples should be:
24- Copy-pasteable (complete, not snippets)
25- Tested against actual codebase
26- Ordered from simple to complex
27</principle>
28
29<principle name="progressive-detail">
30Start with what users need most, hide complexity:
311. Installation (first 30 seconds)
322. Quick example (first 2 minutes)
333. Common use cases (first 10 minutes)
344. Advanced topics (when needed)
35</principle>
36
37</essential_principles>
38
39<intake>
40What would you like to document?
41
421. **Generate full documentation suite** - README, CONTRIBUTING, CODE_OF_CONDUCT, CHANGELOG, architecture, API docs
432. **Generate a single document** - Create or replace one specific document
443. **Update existing documentation** - Refresh docs based on code changes
454. **Audit documentation** - Check what's missing or outdated
46
47**Wait for response before proceeding.**
48</intake>
49
50<routing>
51| Response | Workflow |
52|----------|----------|
53| 1, "full", "suite", "all", "complete" | `workflows/generate-full-suite.md` |
54| 2, "single", "readme", "contributing", "one" | `workflows/generate-single-doc.md` |
55| 3, "update", "refresh", "sync" | `workflows/update-docs.md` |
56| 4, "audit", "check", "missing" | `workflows/audit-docs.md` |
57
58**After reading the workflow, follow it exactly.**
59</routing>
60
61<reference_index>
62All domain knowledge in `references/`:
63
64**Styling:** github-styling.md (badges, emoji, collapsible sections, modern conventions)
65**Document Types:** doc-types.md (what each document should contain, best practices)
66**Code Analysis:** code-analysis.md (how to extract info from source files)
67</reference_index>
68
69<template_index>
70Output templates in `templates/`:
71
72| Template | Purpose |
73|----------|---------|
74| readme-template.md | Modern README with all sections |
75| contributing-template.md | Contribution guidelines |
76| code-of-conduct-template.md | Community standards |
77| changelog-template.md | Version history format |
78| architecture-template.md | System design documentation |
79| api-docs-template.md | API reference format |
80</template_index>
81
82<workflows_index>
83| Workflow | Purpose |
84|----------|---------|
85| generate-full-suite.md | Create complete documentation set |
86| generate-single-doc.md | Create one specific document |
87| update-docs.md | Refresh existing docs from code |
88| audit-docs.md | Check documentation completeness |
89</workflows_index>
90
91<success_criteria>
92Documentation is complete when:
93- All generated docs accurately reflect the codebase
94- README provides working quick-start example
95- Installation instructions are tested
96- API documentation covers all public interfaces
97- Styling is consistent across all documents
98- Links between documents work correctly
99</success_criteria>
majiayu000