Skip to content

Commit cce43dc

Browse files
Update capabilities documentation with recommended best practices (#1066)
Co-authored-by: codegen-sh[bot] <131295404+codegen-sh[bot]@users.noreply.github.com>
1 parent b91453a commit cce43dc

File tree

1 file changed

+36
-1
lines changed

1 file changed

+36
-1
lines changed

docs/gen/capabilities.mdx

+36-1
Original file line numberDiff line numberDiff line change
@@ -64,4 +64,39 @@ Codegen's brain (powered by Claude 3.7 Sonnet) intelligently selects and combine
6464
3. Execute the necessary actions across GitHub, Linear, and your codebase
6565
4. Provide clear, helpful responses back in Slack
6666

67-
This seamless integration allows you to manage your entire development workflow through simple conversations, without having to switch between different platforms and interfaces.
67+
This seamless integration allows you to manage your entire development workflow through simple conversations, without having to switch between different platforms and interfaces.
68+
69+
## Recommended Best Practices for Using Codegen
70+
71+
Here are some recommended best practices for integrating Codegen effectively into your development workflow:
72+
73+
### Workflow Integration
74+
75+
- **Small bug fixes**: For minor issues, consider using Codegen for instant fixes and merges
76+
- **Larger tickets**: A multi-step approach often works best:
77+
1. Ask Codegen to do a first pass on the implementation
78+
2. Check out the branch and review the changes
79+
3. Add any necessary adjustments
80+
4. QA the changes
81+
5. Merge the code
82+
83+
### When to Use Codegen vs. IDE
84+
85+
Consider using Codegen for:
86+
- Initial exploration and first pass on tickets and engineering efforts
87+
- Quickly gathering context on issues (e.g., explaining errors in notification threads)
88+
- Understanding the "blast radius" of a given change to assess its impact
89+
- Getting a solid first pass at approximately 80% of your work
90+
91+
Use your preferred IDE (like Cursor or VS Code) for:
92+
- Making precise adjustments after Codegen's first pass
93+
- Detailed work that requires deep context
94+
95+
### Effectiveness Tips
96+
97+
- Be diligent about analyzing tasks and determining how to break them down for Codegen
98+
- Split complex tasks into manageable chunks
99+
- Don't hesitate to discard unhelpful outputs and try a different approach
100+
- View Codegen as a powerful assistant rather than an infallible oracle
101+
102+
These practices can help you leverage Codegen effectively while maintaining high code quality and productivity.

0 commit comments

Comments
 (0)