TE
TechEcho
Home24h TopNewestBestAskShowJobs
GitHubTwitter
Home

TechEcho

A tech news platform built with Next.js, providing global tech news and discussions.

GitHubTwitter

Home

HomeNewestBestAskShowJobs

Resources

HackerNews APIOriginal HackerNewsNext.js

© 2025 TechEcho. All rights reserved.

Ask HN: Examples of good technical design docs

14 pointsby grualmost 5 years ago
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.<p>I have found resources describing the templates, the &quot;hows&quot; and &quot;whys&quot; of TDD, but I struggle to find some actual, real-life examples.<p>Can you recommend any good technical design docs? Or any other resource that would make you better at writing such documents?

3 comments

wh-uwsalmost 5 years ago
I got a lot of good information on writing design docs from here<p><a href="https:&#x2F;&#x2F;www.industrialempathy.com&#x2F;posts&#x2F;design-docs-at-google&#x2F;" rel="nofollow">https:&#x2F;&#x2F;www.industrialempathy.com&#x2F;posts&#x2F;design-docs-at-googl...</a><p>also if you just Google the 2 words &quot;design docs&quot; there&#x27;s actually a surprising amount of useful things that pop up
评论 #24189149 未加载
asicspalmost 5 years ago
These might help:<p>* <a href="https:&#x2F;&#x2F;github.com&#x2F;jenniferlynparsons&#x2F;awesome-writing" rel="nofollow">https:&#x2F;&#x2F;github.com&#x2F;jenniferlynparsons&#x2F;awesome-writing</a><p>* <a href="https:&#x2F;&#x2F;www.divio.com&#x2F;blog&#x2F;documentation&#x2F;" rel="nofollow">https:&#x2F;&#x2F;www.divio.com&#x2F;blog&#x2F;documentation&#x2F;</a>
w_t_paynealmost 5 years ago
Here&#x27;s a good resource that I find useful:- <a href="http:&#x2F;&#x2F;everyspec.com&#x2F;USAF&#x2F;USAF-SMC&#x2F;SMC-S-012_16JAN2015_52130&#x2F;" rel="nofollow">http:&#x2F;&#x2F;everyspec.com&#x2F;USAF&#x2F;USAF-SMC&#x2F;SMC-S-012_16JAN2015_52130...</a>