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

科技回声

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

GitHubTwitter

首页

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

资源链接

HackerNews API原版 HackerNewsNext.js

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

Documentation is more important than tests

4 点作者 onel4 个月前

3 条评论

bfeynman4 个月前
Abhorrently bad take and misses the biggest reason that documentation usually is a second class citizen, and that is because your code is law, and code and tests are coupled, while documentation is not (thats why there is such huge push for autogeneration). Even code comments are considered a code smell because they are not part of CICD process. The way they describe documentation here reads more like a feature story and not being able to fully complete a spec, which is a tangential problem.<p>For LLM aspect - My take is the better approach is similar context enrichment for rag - you ask the LLM to generate a summary for a page, and that can easily be cached against a digest&#x2F;hash for any code changes - and will always be up to date.
评论 #42648465 未加载
mtrovo4 个月前
From my perspective leading a freshly launched MVP, I don’t believe documentation unilaterally outweighs testing, especially for a product that’s still finding its footing. Our tight resources are better spent establishing solid test coverage and integrating that into CI&#x2F;CD for quick feedback loops. Code itself never lies; unlike static docs, it’s guaranteed to stay current as long as we commit changes responsibly. For the future I’d love to see us leverage AI-driven documentation solutions to replace the manual overhead of keeping separate docs in sync with our code.
PaulHoule4 个月前
Tests and documentation are like peanut butter and jelly.<p>Tests can be examples of how to do things. If examples in your documentation aren&#x27;t backed by unit tests they don&#x27;t work.
评论 #42648387 未加载