Therefore store your architecture diagrams in the repo docs\ folder. Standardizing where your organisation stores architecture diagrams ensures a consistent experience among developers. Brendan Richards, SSW Solution Architectįigure: Good example - SSW People (a Static Site - Gatsby and React with Dynamics 365 and SharePoint Online) - you can just as easily create colorful, engaging diagrams suitable for all of your project stakeholders Tip #9: Where to store Diagrams?.Later, the solution design starts to solidify and we can then use the last state of the whiteboard to make out first architecture diagram. Early use of the whiteboard is all about immediate communication. There is no software or skills required to participate in whiteboard collaboration.Ī key milestone in the early engagement is the first time a client takes the pen and starts using the whiteboard to explain something to me. It allows us to start working together straight away, building a shared understanding of what we're trying to achieve. Putting something on a whiteboard is "low risk" for the participants as its really easy to wipe and redraw. Most pieces of software architecture I do, work starts by building a rough solution architecture diagram on a whiteboard. If you want to save paper, and increase collaboration, a great alternative is the trusty old whiteboard.įor me its all about building a shared understanding between the client and the developers. There's nothing wrong with starting out with pen and paper, but your hand-drawn sketch should not be considered your 'done' final architecture diagram. Make sure you use the right tools when creating your architecture diagrams. as well as all the icons and typography being consistent, you can see that data is a solid line and auth traffic is a dotted line Tip #6: Start with paper. See SSW rule: Do you generate the VS Dependency Graph?įigure: Good example - SSW Rewards (Xamarin with Azure Active Directory B2C) - consistent styling is used. NET dependency diagram, but don't use it here in place of the architecture diagram. If it adds value to your documentation (i.e., there is a specific reason to include it) you can include the. NET dependency diagram is a useful tool, but it drills down into a specific component of the solution (the code) while ignoring the rest of it (the infrastructure). NET Dependency Graph as a Architecture Diagram Your diagram needs to include the relationships between these components, and how they share and process data. Usually, the longer an architecture diagram takes you to make, the more important it is for your project.Īn architecture diagram is part of the 7 crucial documents you need for your project, see our rule: Do you make awesome documentation? Tip #1: Include your most important componentsĪt a minimum, your architecture diagram should include: Figure: Bad example - A screenshot of the Azure resources used helps, but doesn't show data flows or dependenciesĭepending on the complexity of your solution and your comfort/familiarity with the tools, an architecture diagram could take you anywhere from half an hour to a couple of days.
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |