在我作为软件开发人员的5年IT生涯中,我注意到开发人员对任何文档都有强烈的厌恶。拍摄截图和创建文档的行为似乎是一种痛苦而费时的经历。在我工作的一家公司,我们有一个技术文档团队,有两个技术作者,他们为我们的客户开发了所有的用户指南。在我建议雇佣一位技术作家的其他公司,我被告知他们不值得这些钱,但我有点不确定这听起来是不是真的。让开发人员停止编写代码,花半天时间做屏幕截图并创建各种指南更好,还是值得雇用处理此类任务的人员?
发布于 2011-03-02 00:48:37
我要说的是,归根结底,这取决于开发人员在编写技术文档方面的熟练程度,以及他们在多大的压力下从事其他与开发有关的工作,因为这显然会影响质量。
如果您有开发人员(S)有时间和技能来编写高质量的技术文档,那么就太棒了,因为没有人比开发人员更了解软件。
在技术文档中使用“局外人”的优点是,他们可以从用户的角度写东西,并注意到开发人员可能不会写的东西,因为它可能已经在他们的日常生活中根深蒂固了。
这些文档还可以反映软件的质量,因为它可能是用户在安装/购买之前的第一步,特别是如果您的用户已经是技术人员,所以必须正确地给用户第一印象。
因此,总之,他们对任何团队都是有价值的,他们付出的代价最终是值得的(他们不需要成为一个固定的固定单位,你也可以腾出一些开发时间)。
发布于 2011-03-02 00:36:05
我团队中的技术撰稿人主要扮演编辑的角色。
我们比他们更了解我们的制度,他们也比我们更了解文字。
作为开发人员,我们负责记录我们自己的工作,而技术编写人员则致力于规范我们团队产生的各种各样的风格和质量。
发布于 2011-03-02 05:52:10
我做技术作家已经20多年了。大多数开发人员不喜欢编写文档。如果你不喜欢做某事,你就不太可能把它做好。帮大家个忙,雇个专业人士。你不会指望他们会写营销或销售资料吧?
https://softwareengineering.stackexchange.com/questions/53664
复制相似问题