Template for Tech Analysis
Template for Tech Analysis
Navigating Software Engineering: A template for Technical Analysis, my companion for the last 5 years
In this issue, we'll dive into the depths of technical analysis using a meticulously crafted template. It's not just a tool; it's been my faithful companion for the past 5 years, evolving alongside me and gracefully tackling every challenge.
I use this template for technical analysis, as a one-pager, once I have the requirements from Product side, before jumping into the Technical Story Mapping and so on.
Now, let’s describe each of the sections, so you have a better understanding of how to use it.
Status table
In this status table, I track
The last update date
The status of the document regarding different collaborators, like architecture or security.
Links to Jira tickets that I created during the analysis. Usually an epic, not every single Jira ticket.
Introduction
I start with an introduction that not only orients but clearly establishes the purpose of the analysis. This section has been my beacon when I had doubts and needed to focus.
Considerations
In this phase, I delve into key considerations impacting the analysis. With a pragmatic approach, I address constraints and requirements. I used to include here as well possible limitations or restrictions.
Architecture
My favorite part. I present the architecture with both high-level and precise diagrams ranging from the overall vision to crucial details of flow and state. Each component is depicted, indicating which system/service is from my team and which is not, providing a clear vision of the system's structure.
User Journey
I meticulously explore user paths, the most important ones at least, detailing each scenario and its corresponding solution. This methodical approach ensures that every user interaction is carefully considered and optimized.
Architecture Decision Records (ADR)
This section is focused on outcomes. I link to key Architectural Decisions that might be produced from the decisions made during the analysis, transforming them into records that will endure.
Meetings
I annotate each meeting with business details: attendee lists, notes, decisions made, and next steps. This professional record ensures clear traceability and shared understanding at every stage of the analysis.
Links
I conclude with a links section directing to relevant resources.
Final Words
In conclusion, this template is not just a technical guide but my trusted companion over the past 5 years, accompanying the software engineers of my teams as well.
I would love to hear your feedback on this template. How has your experience been using it? Was there any aspect you found particularly helpful or any improvement you would suggest? Your feedback is invaluable to me and will contribute to continuously enhancing this newsletter. Please share your thoughts and experiences with me!
May this template also be your ally in your future projects.
Best,
Marcos