From User Guide
User Guide
This is the User Guide for Architexa, the interactive tool suite that helps developers easily Understand and Document code.
The Diagramming Tools section provides you information about the different types of diagrams and how you can create them with the suite. The Supporting Views & Miscellaneous section describes the helpful views available in Eclipse which help you navigate better through your diagrams, also other miscellaneous tasks. Next are the Understanding, Documenting and Code Review sections which provide some guidelines about your day to day code understanding, documenting and code review tasks.
Once you have created diagrams for your code the Sharing Tools section provides you information about the different ways you can share those with your peers. To help you document effectively some best practices have been mentioned in Best Practices for Creating Documentation. The Configuration section provides you information to manage your account and configure the Architexa plugin.
Contents |
Diagramming Tools
Sharing Tools
Views & Miscellaneous
- Supporting Views
- Miscellaneous
Common Tasks
- Understanding Tasks
- Documenting Tasks
- Code Review Tasks
- Sharing Tasks
- Miscellaneous
Understanding
- Understand a new project, library, or section of code
- Understand code you have been looking at (create diagram from open tabs)
- Find cycles in your architecture
- Search for a specific word or phrase and opening the results in a diagram
- Debug easily by using diagrams to see control flow
- Analyze logic (and ensure all cases are handled effectively)
- Have easier code reviews by understanding changes with diagrams
Documenting
- Tips for Documenting
- Best Practices
Code Review
- Review your code changes before committing
- Review a team member's committed code
- Document the impact of changes on the code architecture
- Track your diffs alongside diagrams
