0
点赞
收藏
分享

微信扫一扫

研发项目文档重要吗?如何保障文档交付和内容质量?


关于研发与文档相爱相杀的故事,实在听过太多,每隔一段时间,就会被“一而再,再而三,三而万”地提起。

研发项目文档重要吗?如何保障文档交付和内容质量?_人工智能

研发项目文档重要吗?如何保障文档交付和内容质量?大家好,我是睿齐,一个技术传播者。

研发项目文档重要吗?如何保障文档交付和内容质量?_js_02

关于这个问题,首先我要给出肯定的答复:重要,尤其是对于大型研发项目。研发项目文档存在的意义,并不是文档本身,而是协调各部门工作,对齐关键信息,以及留存知识资产。明确了这一点,结合研发过程中可能存在的低效沟通、难以追溯等问题,就能感受到,研发项目文档是不是一个痛点问题。

举个例子,我司主要从事芯片及相关软硬件产品研发,与研发强相关的部门包括:芯片研发;硬件研发(包括结构);系统软件研发;工具软件研发;驱动软件研发;产品经理;项目经理——勉强把文档研发也硬塞进去吧,刷一波存在感。所以在实际工作中,信息的流动和依赖关系复杂;研发周期漫长;涉及部门/人员众多。在这样地情况下,文档的重要性不言而喻——实际上,文档质量问题并不是由我提出的,而是自上而下提出的。

作为一个技术文档工程师,一般来说,职责定位主要保障对外交付的文档质量。但是受到公司信任和委派,我也会从系统建设的角度切入,期望提升企业内部文档,尤其以研发项目文档为主,的整体质量水平。

但是研发项目文档,归根结底是需要研发人员自行输出。我看到有朋友提到:

研发项目文档重要吗?如何保障文档交付和内容质量?_js_03

实际上,这个方法并不现实:要求文档工程师覆盖全研发流程,输出研发项目文档?这个成本,没有研发团队愿意承担,关键是,也没有这个必要。

个人认为,比较可行的解决方式是,深入研发流程,梳理研发流程中的信息需求和依赖关系,完善相关的内容规范(模板)和评审规范,从系统上保障研发文档的质量

事实上,最近我一直在做这样的尝试和努力,希望可以切实地改进研发项目文档的质量。后续也会把相关经验,在自己的微信公众号(TC研修实验室,ID:techcomm)和知乎号分享,有兴趣的朋友可以关注,或者跟我交流,帮助我更全面、更深度地思考。

研发项目文档重要吗?如何保障文档交付和内容质量?_js_04

睿齐

技术传播从业者

品牌内容策划

自由摄影师

自由撰稿人

汪力迪

公众号:techcomm / htstory

研发项目文档重要吗?如何保障文档交付和内容质量?_人工智能_05

举报

相关推荐

0 条评论