Home
Ask HN: What are great examples of high level design documentation for software?
I have over twenty years of software engineering experience and I've seen countless examples of architecture documents but I rarely see a high level design document that really stands out. I'm also surprised that there isn't a de facto specification or book that I know of.<p>What are good examples or templates for a high level design that you use for describing distributed systems? Is there a book or similar resource that I'm missing?
3 comments
9wzYQbTYsAIcover 2 years ago
This is likely not what you are looking for, but worth pointing out, as the web is a distributed system.<p><a href="https://datatracker.ietf.org/" rel="nofollow">https://datatracker.ietf.org/</a><p><a href="https://www.w3.org/standards/" rel="nofollow">https://www.w3.org/standards/</a><p>edit: Not as formalized as other documents, but you you might enjoy this high-level document: <a href="https://www.w3.org/DesignIssues/LinkedData.html" rel="nofollow">https://www.w3.org/DesignIssues/LinkedData.html</a><p>Both IETF and W3C use strong templates for their documents and have well established processes for working groups.
StuckDuckover 2 years ago
I think the gnome project deserves a mention here, their docs program is really complete, and covers many high level aspects of how to use the software. Most gnome apps also use it
评论 #33838063 未加载
_448over 2 years ago
> I'm also surprised that there isn't a de facto specification...<p>Wasn't OMG/UML suppose to do that?