对产品和软件文档感到困惑?别担心,它们是一样的!

Avatar of Author
Ciaran Sweet
on July 02, 2021 · · filed under Product Documentation Product Management Documentation Portals Product Updates Best Practices Technical Writing API Documentation Product Documentation Tutorials

产品团队和软件团队都有一个共同的毛病:文档。

产品文档是指面向用户的手册和指南,解释产品的工作流程和用户界面。普通用户如何才能在这个产品上取得成效?在这个意义上,产品文档可以用于软件产品。

软件文档指的是软件产品的基础技术、先决条件和可配置属性。IT管理员如何为用户配置、监控、托管和部署该软件产品?这种类型的文档很重要,特别是当多个版本或分支被添加到组合中时。

在某种意义上,产品文档就像教人如何驾驶汽车。轮子转动汽车,加速踏板移动汽车,刹车踏板停止汽车。软件文档教人如何开车。车轮与前轴相连,前轴转动前轮胎以改变行驶路线;油门增加发动机的气流,吸入更多燃料,产生扭矩和马力。

这两种文件类型都很重要。一个是教育用户的,一个是教育管理员和开发人员的。向人们展示如何驾驶汽车是很好的,但如果没有人知道汽车是如何工作的,当汽车发生故障时怎么办?

产品和软件文档之间的细微差别

产品文档和软件文档有一些小的区别需要注意:

软件和产品文档:目标受众和角色

产品文档的目标受众只有一个:用户。它假定用户没有技术知识,用简单的英语和最少的专业术语进行交流。就像一个技术学徒和一个大学学位一样,它教育人们如何做事,而不注重理论或概念知识。

软件文档是针对IT管理员、工程师和开发人员的。它涵盖了软件的设计和架构、命令行设置说明、API和集成支持、数据管理和报告、网络拓扑结构--基本上就是使机器工作的齿轮。这些文件形成了一个单一的事实来源(SSOT),IT人员在监控和排除软件应用的故障时可以参考。

软件和产品文档:更新频率

软件文档必须在新的提交被合并到主发布通道时持续更新。软件文档必须强调新的功能和命令,并废除旧的功能。应记录新的或变化的依赖关系,并澄清对所有目标平台的功能支持--例如一个功能可以在Windows上使用,但不能在Linux上使用。

只有当基础软件的编辑引发工作流程或可用性的变化时,产品文档才需要更新。一个开发者改变了支付网关的代码,但用户的支付过程保持不变,所以不需要更新。

这显示了软件产品文档的一个自然层次结构。技术性的软件文档构成了基础,而后续的产品文档则建立在这个基础之上。因此,重点应该放在制作优秀的软件文档上,因为它孕育了更优秀的产品文档。

产品和软件文档的格式框架示例

一篇产品文档可以遵循这个框架:

*产品名称

产品目的概述

*设置指南

功能1的解释和图片

功能2的解释和图片

*客户支持链接

同样地,一份软件文档也可以遵循这个框架:

*软件名称

软件目的概述

*软件的依赖性

*安装指南

功能1的解释和图像

功能2的解释和图像

*技术支持链接

很明显,这两种文档类型彼此密切相关,并遵循类似的结构。这意味着产品和软件团队有很多东西可以互相学习,在文档方面合作时也有很大的潜力。

产品和软件文档团队可以相互补充

产品和软件文档之间存在着明显的相似性。这就提出了一个问题:产品和软件团队可以一起工作吗?

是的,他们可以,而且他们应该

软件团队了解技术术语和基础技术。产品团队了解用户看到的、想要的和需要的东西;用户体验。软件文档的作者可以提供详细的技术信息,而产品文档的作者可以稀释技术细节,供非专业人士阅读。

想象一下,试图用外行人的术语解释一些东西,却没有高层次的理解来制定一个外行人会理解的东西。这就是在软件文档之前创建产品文档时发生的情况。

什么是量子力学?薛定谔的猫可能是你脑子里的第一个想法!但是,量子力学有什么用?但是量子力学和猫有什么关系呢?对用户来说,这并不重要。对物理学家来说,它意味着一切。

从软件文档开始,以Docsie中更好的产品文档结束

总而言之,使用软件文档作为后续产品文档的模板有很多好处。软件文档应该作为IT人员和产品文档编写者的单一真理来源。写完后,产品文档编写者将有清晰的认识,可以简化并与客户分享用户友好的知识,并有技术指导进行校对和质量保证。

简单地说,通过从优秀的软件文档开始,你的写手可以精心制作出更优秀的产品文档

开始精心制作文档,帮助您的客户做更多的事情。注册我们的创业计划(永远免费e!),用Docsie提供令人满意的文档服务


Subscribe to the newsletter

Stay up to date with our latest news and products