Documenting Software Architectures

What Hacker News says

1. lemonwaterlimeMay 2024
   Also an engineer doing software. The best book I’ve found for this is “Documenting Software Architectures” by Clements et al. It’s a lot but it shows different reasons to use different styles of diagrams and when they are appropriate. For instance, when it comes to creating diagrams for certain stakeholders versus others or when the system is structured in a certain way, certain diagramming techniques would be better than others.
   Show morethread
2. deepaksurtiJan 2020
   The book `Documenting Software Architectures ...` [1] can help.

   [2] and [3] list a few example documents for Software Architectures, you can google further and find some more.

   I think reading through a few sample documents and based on the expectations at your current job, you can derive the necessary doc.

   [1] https://www.amazon.com/Documenting-Software-Architectures-Be...

   [2] https://projects.cecs.pdx.edu/attachments/download/3146/Soft...

   [3] https://www.voa.va.gov/DocumentView.aspx?DocumentID=188

   Show morethread
3. hoerzuDec 2024
   Here is a list so far: - Designing data intensive applications

   - Just Enough Software Architecture

   - Domain Driven Design - Tackling Complexity in the Heart of Software (Eric Evans) I recommend this one more than Vaughn Vernon's DDD.

   - Clean Architecture (Robert Martin)

   - Fundamentals of Software Architecture: an Engineering Approach

   - Design Patterns (Gamma et al)

   - Site Reliability Engineering: How Google Runs Production Systems

   - Refactoring: Improving the Design of Existing Code (2nd Edition) (Addison-Wesley Signature Series (Fowler))

   - Refactoring to Patterns

   - Patterns of Enterprise Application Architecture

   -Head First Design Patterns Building Extensible and Maintainable Object Oriented Software and I

   - https://www.youtube.com/watch?v=odxOPxYJdjg

   - "Architecture Modernization: Socio-technical alignment of software, strategy, and structure"

   - Software Architecture in Practice

   - Documenting Software Architectures: Views and Beyond

   - Head first: Software Architecture

   Show morethread