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: Is UML the best option design documentation?

3 pointsby jasongullicksonalmost 15 years ago
For design documentation, is there something better than UML?

1 comment

hgaalmost 15 years ago
I would worry a lot more about a process that keeps the design documentation in sync with the code and systems than the form it takes.<p>Design documentation violates the Don't Repeat Yourself (DRY) rule and how often have you seen it, especially at the fine grained level of UML, keep up with the code instead of being abandoned early in the process?<p>So maybe you should look at round-trip tools, or methods to automatically generate documentation from easy (enough) to maintain in your code stuff (Javadoc is one well known low level example of this).<p>Or keep it so simple it won't be a burden to keep up to date, but then you're probably not talking an all-in UML approach.
评论 #1581363 未加载