如果文档被编写但从未被阅读，那么它曾经存在过吗？
如果文档被编写但从未被阅读，那么它曾经存在过吗？
大多数文档都是无用的。这些类型是绝对重要的。
此外，作为对“文档有点像人死亡”这篇文章的回应，我还发现我的客户中没有人相信来世，或者至少在我去世后没有人联系我。；)
我同意技术代码文档。技术代码文档的最好形式是一个写得很好的集成测试。至少感觉是这样，不确定其他人是否也有同样的感觉。
技术文档的最好形式也是函数名。这还假设您没有将大量代码塞进同一个函数中。(1 公吨= 30 行代码。)
所有没有写入代码的代码文档都是无用的。我还注意到，对编码最感兴趣的人是不再编码的经理。他们说，我不打算用这个，但是学这个会很好，这样我就可以帮助别人了。这就像临死前的忏悔——对不起，伙计们，你们要下地狱了……呃，我的意思是，你们还是不会理解代码。
不要试图提出关于已经写好的东西的无意义的技术文档，定期召开代码审查会议。你知道，就像你应该在母亲节给奶奶打电话，而不是攒钱买一束花和一句吸引人的殡仪馆访客手册。
如果你觉得有必要写，就写一些如何使用现有代码创建新功能的例子。供重复使用的文档。但总的来说，只需编写简单的代码，或者创建一个文档，上面写着“请现在杀了我。”回想起来，我们都会担心是修复一个问题更容易，还是重写一遍更容易。
有些形式的文件是非常需要的。
商业文件。求你了。拜托…没有什么比试图在几千行代码中排除一个 50 万美元的会计错误更糟糕的了，当你问会计为什么软件会这样做时，他们给你一张空白的脸。(这也是我如何结束学习会计基础知识的。)
同样重要的是，整合。这意味着你的网络拓扑和系统 A 如何与系统 b 协同工作的其他拼写。(别忘了解释这些缩写的意思。)当我谈到关于集成的一段时，让我们称数据库为集成。它是一个完全独立的系统，有自己的语言。如果没有别的，数据字典可以走很长的路。
最后，保存关于如何设置环境的文档。我自豪地经历了在没有提供实际的当前数据库模式的情况下让应用程序工作的反复试验。我记录了我所经历的过程。我是先锋。然后，雇佣来替代我的承包商花了接下来的六周时间来设置他们的环境，尽管我发送了几封电子邮件，都以“这一步就像文档中的步骤 x，为什么我的眼睛在流血？”所以，是的，没有像傻瓜证明环境设置文档这样的东西——总有一些新的傻瓜需要证明一些东西。(或者另一个承包商团队被指派了一个驱动程序开发人员来领导一个 web 项目，因为他的老板需要更多的利用率。)
但是，是的——除了整合、业务和环境设置——你的最后几个小时最好花在你的遗愿清单上，而不是无聊的克里夫笔记自传。下一次我被要求提供文件时，我会递上一本《圣经》并说:“读我的文字，因为它们赋予生命而不会死亡。”然后在圣经里面会有一张给 Pluralsight 和 Udemy 的礼品卡。
如果你喜欢我的回答，请推荐并按下心脏。
黑客中午是黑客如何开始他们的下午。我们是 @AMI 家庭的一员。我们现在接受投稿，并乐意讨论广告&赞助机会。
要了解更多信息，请阅读我们的“关于”页面、在脸书上点赞/给我们发消息，或者简单地说， tweet/DM @HackerNoon。