Examples of good technical design docs

Question

As part of an interview process, I have recently received a take home assignment of writing a technical design doc for a simple web app. Turns out I badly suck at it.I have found resources describing the templates, the "hows" and "whys" of TDD, but I struggle to find some actual, real-life examples.Can you recommend any good technical design docs? Or any other resource that would make you better at writing such documents?

wh-uws · Accepted Answer

I got a lot of good information on writing design docs from here
https://www.industrialempathy.com/posts/design-docs-at-googl...
also if you just Google the 2 words "design docs" there's actually a surprising amount of useful things that pop up

asicsp · Answer

These might help:* https://github.com/jenniferlynparsons/awesome-writing* https://www.divio.com/blog/documentation/

w_t_payne · Answer

Here's a good resource that I find useful:- http://everyspec.com/USAF/USAF-SMC/SMC-S-012_16JAN2015_52130...

Examples of good technical design docs

I got a lot of good information on writing design docs from herehttps://www.industrialempathy.com/posts/design-docs-at-googl...also if you just Google the 2 words "design docs" there's actually a surprising amount of useful things that pop up

These might help:* https://github.com/jenniferlynparsons/awesome-writing* https://www.divio.com/blog/documentation/

Here's a good resource that I find useful:- http://everyspec.com/USAF/USAF-SMC/SMC-S-012_16JAN2015_52130...

I got a lot of good information on writing design docs from here
https://www.industrialempathy.com/posts/design-docs-at-googl...
also if you just Google the 2 words "design docs" there's actually a surprising amount of useful things that pop up

These might help:
* https://github.com/jenniferlynparsons/awesome-writing
* https://www.divio.com/blog/documentation/