假设我有一个复杂的软件产品,其信息或知识分散在构建它的组织中。有些要求和特性,即使是质量保证/测试部门也不太确定。
同样的通用软件产品也有很多方面,并且产品会根据客户的业务需求不断地进行定制。此外,当你试图探索的软件手,然后往往会迷路,因为它的复杂性。
我确切地想知道的是,一个文档如何按照上述场景编写最终用户指南。
发布于 2017-01-07 16:25:07
试着说服你的经理或任何想出这一任务的人,为处于如此简陋状态的软件编写最终用户文档并不是个好主意。它甚至会增加技术债务,因为您创建了另一个文档,该文档将从一开始就存在空白并包含错误,并且需要与软件保持同步。
从长远来看,首先记录软件的需求、定义测试用例、实现自动化测试以及在有意义的地方重构会更便宜。有了合理的需求和变更管理,编写最终用户文档并使其与软件保持同步将更加容易。
如果这不是一个选项,与一些关键用户交谈,了解他们如何使用该软件,记录他们的用例,添加一些图表,尽可能显示软件的主要模块,粘贴一些截图,尽可能好地解释输入和输出文件。最后,您将得到一份至少看起来像用户指南的文档,甚至在有限的时间内可能会有一些有用的内容。但是,请确保您不是负责维护文档的人。
在某些情况下,这确实是最好的选择,因为在许多软件项目中,从业务角度来看,最终用户文档的优先级非常低。这是因为它对项目的成功影响不大。
https://softwareengineering.stackexchange.com/questions/339652
复制相似问题