如何改进研发项目文档内容质量?

2023-11-05

书接上回:研发项目文档重要吗?个人以为,改进研发项目文档内容质量,需要深入研发流程,梳理研发流程中的信息需求和依赖关系,完善相关的内容规范(模板)和评审规范,从系统上保障研发文档的质量。

所以这段时间,协调痛点场景作为改进试点,参与到研发设计/方案评审会,虽然免不了会让人觉得“你一个排版的懂什么”,但还是要依着自己的想法,捕捉一切蛛丝马迹,寻找可能存在的改进点。

领导说:你写个问题说明PPT吧。嗯,那我就基于个人有限认知,简单地分享两句吧。大家好,我是睿齐,一个技术传播者。

当我们谈研发项目文档时,我们谈些什么?

一提到研发项目文档内容质量,很多研发同事可能会立即生出误解和抵触:

  • 是不是又要为写文档而写文档了?

  • 是不是又要咬文嚼字儿讲语文了?

  • 是不是又要强迫症附体排格式了?

NONONONO,并不是这样。实际上,我们更希望可以从研发项目文档中看到的是:

通过深度思考,明晰产品定义和技术实现,形成系统的文字说明,便于团队成员共享知识,对齐关键信息,达成一致目标,共同实现/验证产品定义;同时,归档知识资产,便于后续跟踪回溯。

所以归根结底,当我们谈研发项目文档时,真正谈的是研发项目信息管理。

就大规模集成产品而言,以我目前的实践深度,贸然讨论研发全流程信息管理,未免显得有点不自量力。所以为了说明原理,在此仅以敏捷开发流程为例。——有朋友可能要说了:我们敏捷开发都不写文档。嗯,咱别杠。

虽然产品、开发(包括代码+文档)、测试来自于不同的部门,但是就项目而言,他们更是实现共同目标的团队成员,对产品交付负责:产品→定义;开发→实现;测试→验证。

在研发过程中,产品、开发、测试彼此之间要共享信息,并且互相依赖。

嗯,上面这张图看不太清楚,也有一些歧义,重新画一下:


但是,由于很多原因,产品/技术信息没有被充分挖掘,顺畅的传递,以至于团队成员疲于沟通,研发进度却迟迟无法推进。具体场景实在太多了,在此仅以测试方案为例,来看看保证文档内容质量遇到了哪些挑战。

很多时候,我们误以为自己为文档编写付出很多,却巧妙地错过了实际使用需求。

针对于具体的文档场景,以测试方案为例,改进文档内容质量,需要从3个方面入手。

保证文档内容质量,绝不是一个部门、一个开发责任人在努力,而是需要充分调动起整个项目团队中每位角色(至少是主管),打破部门壁垒,深度参与贡献知识,共同完成。其中最重要的动作是:技术评审。然而文档评审很可能也是受到诟病最多的部分,以至于,不重视、低效、无结论……如何解决?且听下回分解。

其他推荐:

实施:GitHub + MarkDown 文档系统的工作环境部署及工作流程说明 | 技术传播

技术传播是一片蓝海 | 技术传播

访谈:TC无处不在,只是我们没有发觉 | 技术传播

这次他们说好要“讲真的” | 传播

在座都别吵了,你们还有我 | 技术传播

一本培养强迫症患者的说明书 | 技术传播

就像用心做好日本料理 | 技术传播

顽固的老头子与无聊的说明书 | 技术传播

转战新媒体 | 技术传播

评测:王者荣耀的用户帮助系统 | 技术传播

让爸爸妈妈也能享受到科技发展带来的便利 | 技术传播

企业级信息管理系统初创方案构思 | 技术传播

 

睿齐

技术传播从业者

品牌内容策划

自由摄影师

自由撰稿人

汪力迪

公众号:techcomm / htstory

微信号:bgrichi

邮箱:hash_0813@163.com

本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)

如何改进研发项目文档内容质量? 的相关文章

随机推荐

  • C++中对ODBC的API详解和使用

    本文构成 定义 API 实例 实例在最下面 一 ODBC 1 定义 即开放数据库连接 Open Database Connectivity ODBC 是数据库API的规范 该API独立于任何一个DBMS或操作系统 是为解决异构数据库间的数据
  • iptables Permission denied (you must be root)

    环境 Docker容器 操作 iptables L 现象 iptables v版本 can t initialize iptables table filter Permission denied you must be root 原因 i
  • 【PyTorch】冻结网络参数

    方法一 将需要固定的那部分参数的requires grad置为False 在优化器中加入filter根据requires grad进行过滤 requires grad置为False for p in net XXX parameters p
  • python开发面试刷题指南

    1 装饰器 详解Python的装饰器 装饰器的作用就是给原有函数或对象添加额外的功能 不需要变动原有代码 用于有切面需求的场景 如插入日志 性能测试等产经 返回值是一个函数对象 优点 抽离出函数功能本身无关的雷同代码 可以重用 缺点 经过装
  • 模版之编译期断言

    title 模版之编译期断言 date 2023 02 20 20 28 08 permalink pages 83d2a5 categories 通用领域 编程语言 C tags C 元编程 author name zhengzhibin
  • Redhat6.x bond配置

    bin bash cat gt etc sysconfig network scripts ifcfg bond0 lt
  • 区间预测

    区间预测 MATLAB实现基于QRCNN GRU Multihead Attention多头注意力卷积门控循环单元多变量时间序列区间预测 目录 区间预测 MATLAB实现基于QRCNN GRU Multihead Attention多头注意
  • SpringCloud Stream 消息同步和异步

    1 异步的形式有 通知 单向请求 只管发送不关心结果 请求 异步响应 一对一的交互 请求的信息不回立马返回 而是过一段时间再返回结果 消息 利用消息可以实现一对多形态的交互 2 MQ的应用场景 异步处理 流量削锋 日志处理 应用解耦 3 p
  • 网络安全实验室6.解密关

    6 解密关 1 以管理员身份登录系统 url http lab1 xseclab com password1 dc178aa12e73cfc184676a4100e07dac index php 进入网站点击忘记密码的链接 进入到重置密码的
  • 开源进展

    作为连接实体对象 人或物 的现实身份与链上身份的可信映射 实现实体对象之间安全可信的数据授权与交换 分布式身份技术解决方案在推动区块链应用繁荣及可信数据流转的过程中扮演着重要角色 WeIdentity是由微众银行自主研发并完全开源的一套分布
  • 用python读取txt文件中的数据并画各类图形展示

    捣腾了一下午 终于整出来了 帮助和我一样的菜鸟解决数据读取问题 这是所有做实验的第一步 如果这步都没有解决 下面部分如何展开 这里每一步都很详细的解释了如何操作 我的文件内容 读取数据和画图都在本文末尾都有展示 import pandas
  • 【TensorFlow-windows】(二) 实现一个去噪自编码器

    主要内容 1 自编码器的TensorFlow实现代码 详细代码注释 2 该实现中的函数总结 平台 1 windows 10 64位 2 Anaconda3 4 2 0 Windows x86 64 exe 当时TF还不支持python3 6
  • nvidia-smi 命令详解

    nvidia smi 命令详解 1 nvidia smi 面板解析 2 显存与GPU的区别 Reference nvidia smi命令详解 相关文章 nvidia smi nvcc V 及 CUDA cuDNN 安装 nvidia smi
  • 用Java实现简单计算器

    实训题 8 简单计算器 一 项目说明 实训目的 掌握 Java GUI 开发中的布局管理和事件处理机制 实训要求 1 要使用 java 的 GUI 设计出计算器界面 2 通过界面按钮 可以实现整数或浮点数的四则运算 并能将结果显示在界面中
  • 2020-01-24

    新年快乐 祝各位粉丝以及csdn的朋友 新年快乐 2020没有解决不了的问题 加油
  • Linux/Centos源码安装python3任意版本

    首先安装编译工具 sudo yum y install cmake3 glib2 devel libpcap libpcap devel libgcrypt devel glib2 devel qt devel qt5 qtbase dev
  • js小学生图区_多种方式实现js图片预览

    js多种方式图片预览 持续更新 设置自己的变量存储区 var Util file file image show img show Util file nchange function f if this files 0 type inde
  • IDEA 使用技巧

    1 idea展开折叠类中所有方法 展开 ctrl shift 折叠 ctrl shift 2 Idea中设置注释位置 自动缩进到合适位置
  • 【PID控制算法】

    PID控制小解 比例环节 P 成比例的反映偏差信号 偏差一旦产生 控制器立即产生控制作用 较小误差 积分环节 I 主要用于消除静态误差 提高系统得无差度 积分作用的强弱取决于积分时间常数 Ti Ti越 大 积分作用越弱 反之越强 微分环节
  • 如何改进研发项目文档内容质量?

    书接上回 研发项目文档重要吗 个人以为 改进研发项目文档内容质量 需要深入研发流程 梳理研发流程中的信息需求和依赖关系 完善相关的内容规范 模板 和评审规范 从系统上保障研发文档的质量 所以这段时间 协调痛点场景作为改进试点 参与到研发设计