TE
科技回声
首页24小时热榜最新最佳问答展示工作
GitHubTwitter
首页

科技回声

基于 Next.js 构建的科技新闻平台,提供全球科技新闻和讨论内容。

GitHubTwitter

首页

首页最新最佳问答展示工作

资源链接

HackerNews API原版 HackerNewsNext.js

© 2025 科技回声. 版权所有。

Ask HN: Documentation before starting a software project?

8 点作者 supahfly_remix超过 10 年前
How much up-front documentation do you write before starting a software project? Do you do any tradeoff studies or analysis, and if so, of what?

3 条评论

Someone1234超过 10 年前
I find whiteboard and or Visio diagramming pretty useful (both high level, and more fine grain).<p>However aside from in school I&#x27;ve never documented, designed, developed in the waterfall model style. I&#x27;ve never seen anyone else work that way either in &quot;real life.&quot;<p>Most places either officially use agile-style development or unofficially do (i.e. claim they use the waterfall model, but in reality are going back and updating the requirements&#x2F;design throughout development).<p>Something can be said for Unit Test-first development. However you really need to have good tooling, mocks, and so on before that is viable (otherwise you burn too much time getting even basic unit tests off the ground).
评论 #9064680 未加载
gabrtv超过 10 年前
I&#x27;m a big believer in &quot;Readme driven development&quot; [1]. It&#x27;s critical you go through the exercise of 1) explaining what the software will do and 2) how it will be used with concrete examples. The value of this documentation will always outweigh the time spent writing it.<p>[1]: <a href="http://tom.preston-werner.com/2010/08/23/readme-driven-development.html" rel="nofollow">http:&#x2F;&#x2F;tom.preston-werner.com&#x2F;2010&#x2F;08&#x2F;23&#x2F;readme-driven-devel...</a>
loumf超过 10 年前
The minimum needed at each stage to get buy-in, inform, and help plan.<p>For example:<p>1. At inception, a one-pager to make the business case and get funding&#x2F;backing&#x2F;ok&#x2F;whatever. Audience: executives<p>2. Before starting, the end-user perspective on what is going to be done. Get feedback, use for sizing&#x2F;scheduling. Audience: other departments<p>3. Before too much construction (after a proof-of-concept), an overview of the basic architecture and sketch of a plan. Audience: other developers.