Create clear, comprehensive code documentation that explains functionality, methods, dependencies, and usage examples to help new team members understand your specific project code.
Like this prompt? Use it in Team-GPT for free now →
🗒️
I need to document this <code>{{code}}</code> which is part of our <project>{{project_name}}</project> project. Create comprehensive documentation that includes:
The purpose and functionality of the code
Key methods/functions and their usage
Dependencies and requirements
Example usage scenarios
Any potential gotchas or known limitations
Focus on making it understandable for new team members while keeping it technically precise.