Skip to content

Commit 88053ad

Browse files
Create file
1 parent 280606d commit 88053ad

File tree

1 file changed

+35
-0
lines changed

1 file changed

+35
-0
lines changed

docs/features-and-use-cases.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
Core features:
2+
3+
- Generate documentation: Automatically generate documentation for code files, APIs, and entire codebases using AI
4+
- Interactive tutorials: Create step-by-step interactive coding tutorials with live environments
5+
- Context generation: Generate high-level context and summaries for code files and folders
6+
- Documentation auditing: Find gaps and suggest improvements in existing documentation
7+
- API documentation: Generate API documentation and OpenAPI/Postman configs
8+
- Ask questions: Ask natural language questions about the codebase and get AI-powered answers
9+
10+
Use cases by role:
11+
12+
Frontend Developers:
13+
- Generate component documentation
14+
- Create interactive tutorials for UI features
15+
- Document API integrations
16+
17+
Backend Developers:
18+
- Generate API documentation and configs
19+
- Document database schemas and models
20+
- Create tutorials for backend services
21+
22+
DevOps Engineers:
23+
- Document infrastructure and deployment processes
24+
- Generate context for configuration files
25+
- Create tutorials for CI/CD pipelines
26+
27+
Technical Writers:
28+
- Audit and improve existing documentation
29+
- Generate high-level overviews of codebases
30+
- Create user-facing documentation
31+
32+
Team Leads:
33+
- Generate codebase summaries for new team members
34+
- Document architecture and design patterns
35+
- Create onboarding tutorials

0 commit comments

Comments
 (0)