嵌入式项目需要写哪些文档?

原创 strongerHuang 2024-04-21 13:44

关注+星标公众,不错过精彩内容

作者 | strongerHuang

微信公众号 | strongerHuang


写文档对于嵌入式工程师来说“很难”,特别是一个项目有数十个文档要写的情况下。


那么,你们平时开发嵌入式项目,会写文档吗?一般要写多少个文档?哪些类型的文档?


这类问题也是读者问的比较多的问题,今天就来简单讲讲。

嵌入式项目到底要不要写文档?

有的公司做一个嵌入式项目,从头到尾没有一个文档,都是口头对接。而有的公司,开发一个嵌入式项目,文档有上百份


我曾经开发过0文档的项目,也有五、六十份文档的项目(当然,不全是我写的,我只写了其中几份)

你会发现,嵌入式项目到底要不要写文档,与公司性质、管理、项目大小等有关系。


一般来说,小公司人员不足、管理也不完善,不看重文档。反之,大公司不管项目大小,都有严格的规范,该有的文档一份不会少,即便文档内容不多。


嵌入式项目需要写哪些文档?

严格来说,没有文档的嵌入式项目不是好的项目。


为什么这么说,相信很多读者都接手过“烂项目”,比如前两天给大家分享的《单片机项目中太多全局变量有什么弊端?》。其实,很多烂项目一部分原因就是因为没有文档造成的。


那么,我们站在开发者的角度,你考虑过有必要写的文档有哪些吗?下面分享一下。

1、需求文档

需求文档很关键,所有的后续研发工作都是基于需求而来,它详细描述了嵌入式系统的功能需求、性能需求、接口需求等。并且助于确保开发团队对项目的理解保持一致,并作为后续设计和开发工作的基础。


需求文档在于确定项目的具体目标、功能需求以及性能指标。分析项目的复杂性和可行性,确保所选单片机、各种器件能够满足需求等。


如果公司人员多、细分工作的话,需求文档应该有多个。


2、设计文档

设计文档包括结构设计文档、硬件设计文档、软件设计文档等。


结构设计文档包含结构尺寸、大小、外观等内容,硬件设计文档描述包含嵌入式系统的硬件架构、电路板设计、元件选择等内容;软件设计文档则涉及软件架构、模块划分、接口定义等。


这些文档有助于团队成员理解系统的整体结构和各个部分的功能。


3、开发文档

这里开发文档,也是实现文档。这一部分文档应该是开发者写的最多的,主要是详细描述、记录了嵌入式系统的具体实现过程,包括源代码、头文件、库文件等。


这些文档对于后续的代码维护和升级至关重要,也有助于团队成员之间的代码共享和协作。


你会发现,有时候软件和硬件存在互相甩锅的情况。

4、测试文档

测试文档包括测试计划、测试用例、测试报告等。

详细描述了测试的过程、结果和问题分析,有助于确保嵌入式系统的质量和稳定性。


这里可以参看我之前给大家分享的《嵌入式开发中测试用例怎么写?


5、维护文档

我们软硬件开发过程,以及后续更新都有不同版本,维护文档主要是记录了嵌入式系统的维护过程、常见问题及解决方法等,有助于系统的长期稳定运行和故障排查。


6、其他文档

上面是我们嵌入式项目常见的有必要写的一些文档,如果大一点的公司,可能还存在其他一些文档,比如:总结文档、部署文档、用户手册文档等。


总结

以上只是“大框架",具体如何实现与公司管理、项目等多方面因素都有关,但一个原则,把文档的主要内容描述清楚即可。


写文档可能是工程师比较讨厌的事情,但从项目长远来看,或者说从自生长远的职业发展来说,写文档还是很有必要。


最后,你们开发过程中,有写文档吗?
------------ END ------------



●专栏《嵌入式工具
●专栏《嵌入式开发》
●专栏《Keil教程》
●嵌入式专栏精选教程

回复“加群”按规则加入技术交流群,回复“1024”查看更多内容。



点击“阅读原文”查看更多分享

strongerHuang 作者黄工,高级嵌入式软件工程师,分享嵌入式软硬件、物联网、单片机、开发工具、电子等内容。
评论 (0)
  • 方案概述       在汽车发展和用户需求的推动下,汽车钥匙开始从传统的机械钥匙向数字化、智能化方向发展。目前常见的数字钥匙集成了蓝牙、NFC、UWB等技术实现了移动设备与车端的通信,可以帮助用户便捷的实现车辆功能控制。随着数字钥匙的广泛应用,相关的测试需求也进一步增加,人工测试无法满足测试进度要求,正逐渐被自动化测试所取代。       经纬恒润基于自研的INTEWORK系列产品,推出了数字钥匙自动化测试解决方案,
    经纬恒润 2024-05-29 15:26 68浏览
  • 激光雷达系统需要用精确的时间测量来计算距离和生成高分辨率的3D图像。晶振在激光雷达系统中起着关键作用,主要用于提供稳定的时钟信号和高精度的时间基准。图片来源:Wingtra晶振的作用1. 时间基准: 激光雷达通过发射激光脉冲并测量其返回时间来计算物体的距离。因此需要一个非常精确的时间基准。晶振提供的稳定时钟信号确保时间测量的准确性,从而保证距离计算的精度。2. 数据采集与处理: 激光雷达系统在接收到反射信号后,需要快速进行数据采集和处理。晶振提供的时钟信号用于同步数据采集和处理单元,确保系统能够
    koan-xtal 2024-05-29 13:00 50浏览
  • (什么是蚀刻?)蚀刻是一种利用化学强酸腐蚀、机械抛光或电化学电解对物体表面进行处理的技术。从传统的金属加工到高科技半导体制造,都在蚀刻技术的应用范围之内。在印刷电路板(PCB)打样中,蚀刻工艺一旦出现问题必然是批量性问题,最终会给产品造成极大品质隐患。虽然蚀刻工艺的不断改良及新材料应用,使得印刷电路板(PCB)蚀刻加工的产品良率一直在提升,但是下游客户对于成品的要求也越来越高。侧蚀问题是产品蚀刻过程中经常被提出来讨论的一项,由于目前腐蚀液的固有特点,不仅向下而且对左右各方向都产生蚀刻作用,所以侧
    海伯森技术 2024-05-29 15:06 72浏览
  • 配图来自Canva可画随着人工智能技术的快速发展,大模型以其强大的数字处理能力和深度学习能力,不断与各领域交叉融合,逐步成为产业创新的关键抓手,和驱动新质生产力的关键引擎。据国家最新公布的数据显示,截至今年3月,我国共有117个生成式人工智能服务完成备案,各类国产大模型,更是超过了200多个,多模态的大模型应用场景正在不断拓展。然而,随着大模型的快速发展,算力成本日益成为影响人工智能推广应用的重要因素,大模型产品的价格居高不下,更是长期制约着人工智能应用的发展。近日,随着字节跳动率先将大模型的使
    刘旷 2024-05-29 10:13 78浏览
  • Nginx 是一款高性能的 HTTP 和反向代理服务器,同时也充当 Web 服务器和电子邮件代理服务器。它以其轻量级的特性和高效的性能在网络服务领域得到广泛应用。下面将详细探讨 Nginx 的不同方面: 1. 基本概念   -定义与功能:Nginx (engine x) 是一个高性能的 HTTP 和反向代理服务器,具备处理大量并发连接的能力[^1^]。    -主要特点:其轻量级特性使得 Nginx 在资源消耗上相对较低,适合用于负载均衡、缓存等场景。
    丙丁先生 2024-05-29 08:21 92浏览
  • 介质损耗因数(Dissipation Factor,简称DF)是衡量电介质材料在交流电场作用下能量损耗的一个参数。它与材料的介电性能和内部结构密切相关,对于电子元件如电容器的设计和性能至关重要。以下是介质损耗因数的几个关键含义:能量损耗:介质损耗因数表示在交流电路中,电介质材料每周期内所损耗的能量与存储能量的比值。损耗的能量主要以热的形式散失。材料纯度:介质损耗因数的大小可以反映材料的纯度。纯度越高,材料的介质损耗因数越低,因为杂质和缺陷会增加能量损耗。温度稳定性:介质损耗因数随温度的变化可以指
    仓叔谷粒 2024-05-29 09:59 58浏览
  • 艾体宝干货 | 教程:使用ntopng和nProbe监控网络流量引导语:本教程旨在分享如何通过 ntopng 和 nProbe 这两款工具,深入了解和掌握网络流量监控的艺术。我们将提供从基本概念到高级应用的全面指导,涵盖了在多种平台和设备上的部署和配置步骤。不论您是专业人员还是技术爱好者,跟随本教程,都能够有效地安装、配置并运用这些工具,以洞察网络的运行状态和性能,确保网络安全与高效运行。简介:本文是关于使用 ntopng 和 nProbe 监控网络流量的教程。文章详细介绍了如何配置和使用这两个
    虹科网络可视化 2024-05-29 15:52 95浏览
  • PCI EXPRESS应用的集成10/100/1000M/2.5G以太网控制器(支持REALTEK DRAGON SW进行带宽控制)Realtek RTL8125BG/RTL8125BGS 10/100/1000M/2.5G以太网控制器将四速IEEE 802.3兼容媒体访问控制器(MAC)与四速以太网收发器、PCI Express总线控制器和嵌入式内存相结合。RTL8125BG/RTL8125BGS采用最先进的DSP技术和混合模式信号技术,通过CAT 5e UTP电缆或CAT 3 UTP(仅1
    罗裕成 2024-05-29 15:26 93浏览
  • 设计领域的应用 Midjourney的应用场景广泛而多元,在创意设计领域有着卓越表现。作为一款功能卓越的图像生成工具,Midjourney为平面设计、产品设计、室内设计、建筑设计、时尚设计以及工业设计等多个领域注入了无尽的创作活力。 首先,让我们走进平面设计这一充满创意的艺术领域。Midjourney作为一款强大的图像生成工具,为平面设计师提供了源源不断的创作灵感。在本节中,详细解析Midjourney在平面设计中的实际应用,通过提供平面设计提示词参考,帮助读者丰富提示词语料库。同时,演示了如何
    戈壁滩上绽放 2024-05-29 12:50 136浏览
  • 艾体宝干货 | 用于故障排除的最佳 Wireshark 过滤器引导语:在网络故障排除过程中,Wireshark是一款非常强大的工具,它可以用来分析网络数据包并解决各种问题。本文将介绍一些好用的Wireshark过滤器,以便更有效地进行故障排除。简介:Wireshark是一种流行的网络协议分析工具,可用于捕获和分析网络数据包。在网络故障排除中,Wireshark是一款不可或缺的工具,它可以帮助您识别和解决各种网络问题。本文将介绍一些最佳的Wireshark过滤器,帮助您提取和分析特定的数据包,加快
    虹科网络可视化 2024-05-29 15:49 155浏览
我要评论
0
0
点击右上角,分享到朋友圈 我知道啦
请使用浏览器分享功能 我知道啦