Software architecture document guidelines

Guidelines for creating your own software architecture documents

Back in March last year we published an initial set of software architecture document guidelines and I thought that it was time for an update. There are no major changes although I've modified some of the section headings so that you can use this as a complementary resource to the slides from my Documenting your software architecture - why and how? presentation. As before, I hope you find these resources useful in creating your own software architecture documentation.

Read the full software architecture document guidelines...

About the author

Simon is an independent consultant specializing in software architecture, and the author of Software Architecture for Developers (a developer-friendly guide to software architecture, technical leadership and the balance with agility). He’s also the creator of the C4 software architecture model and the founder of Structurizr, which is a collection of open source and commercial tooling to help software teams visualise, document and explore their software architecture.

You can find Simon on Twitter at @simonbrown ... see simonbrown.je for information about his speaking schedule, videos from past conferences and software architecture training.



Re: Software architecture document guidelines

Really nice and useful one

Re: Software architecture document guidelines

First, I really appreciates the job you have done on software architecture document guidelines. I have already used the first revision of it on my current project.

Second, It is possible to see a real sample of the architecture document with every sections? I looked at the "why and how" presentation and it demonstrates the diagrams part of the software arhictecture document not so much on the textual part. I would like to see an example of the other sections. I haved encounter many difficulties on how to present the informations. I'm sure it will a lot of people.

Thanks.

N.B.: Sorry for my poor english

Re: Software architecture document guidelines

Thanks very much - really good to hear that you've found the guidelines useful.

It's on my todo list. I'll probably put together a software architecture document for the case study in our training course, although that won't necessarily cover all of the sections. I have lots of architecture documents but I can't (unfortunately) publish them. Watch this space, I'll see what I can do.

In the meantime, feel free to use the Google Group if you have any questions.

Re: Software architecture document guidelines

Hi Simon, I'm a student over in the Netherlands and I'm currently working on several projects at my school. I'm basically only learning the basics of software architecture such as UML, coding techniqes, software patterns etc. However (I'm in my last year of school) they never really paid much attention to going into the detail of architecural designing. Since I like to work according to industry standards and processes recognized by the industry I thought it would be great to learn about the architecture process as well. This is what brought me to your site. The projects I'm currently doing are quite small so there are little to no requirements and your free to do as you wish as long as the end product does what they want it to do. I thought this would be great practice for me to work on my architectural skills. However, as I've stated before I know very little about the accual process of architecture. I have books on requirements engineering but architecture was never a main subject. So here is the question it is the same one as above. Though with suggestions. Is there a possibility that you could make up an imaginary software project which combines all the knowledge you will need about requirements, architecture and the accual coding. This would include example product such as an SRD(in this case it could be small since the SAD is the main product) and an SAD. This in combination with the guidelines would be the perfect guide to create your own SAD. I'm saying this because your comment dates back about a month or so and I'm really anxious to learn about creating SAD's.

Add a comment Send a TrackBack