详细内容或原文请订阅后点击阅览
如何正确记录软件
有人声称，对于编写良好的软件来说，文档是不必要的。记录只会是不必要的努力。此外，根据敏捷宣言，应该优先考虑功能性软件，而不是详尽的文档。同时，忽略它可能会导致不必要的瓶颈——即使在敏捷软件开发中也是如此。软件文档还为 […] 提供安全性
来源:机器人与自动化新闻有人声称文档对于写得很好的软件是不需要的。这只是记录的不必要的努力。
根据敏捷宣言，应优先考虑功能软件 - 而不是彻底的文档。同时，即使在敏捷软件开发中，也可能会导致不需要的瓶颈。
软件文档还为用户和项目参与者提供了安全性，他们可以将其用作甲骨文或仪器的一种形式，其中包含有关产品问题的所有答案，包括用例和业务规则如何流入系统。
但是，生产相关的软件文档对于团队可能具有挑战性，这使得过程乏味和文档不利。毕竟，如何有效地记录软件，以便成为组织的战略指南？
在这篇文章中，我们带来了软件文档需要拥有的信息，良好的软件文档指南以及良好软件文档的逐步过程。
软件文档指南软件文档需要具有
软件文档可以帮助公众理解和使用该产品，无论受众是由管理员，同行，技术人员还是最终用户组成的。因此，必须清楚，可搜索，最重要的是有用。
良好的软件文档应增强受众的能力，而不是使他们感到沮丧，为此，它需要具有一些基本要素，例如客户支持。
，不仅如此。该文档还需要根据软件或技术文档指南和信任建设来完成。
这是因为用户最需要文档时会寻找该文档。而且，如果信息不清楚，他们将开始寻找替代方案，在这种情况下，它们可能不是您公司的最佳选择。
下面，我们列出了4个在软件文档中必不可少的项目。他们是：