如何编写嵌入式方案设计文档?

当我看到标题时,可能有人问我,当我是一个嵌入式用户时,为什么要做文档。我不需要和甲方联系,我也不是前台服务员。别担心,我相信每个人都遇到过这样的情况。当领导者看到你的计划时,这是不好的,那是不好的。无论如何,它们都必须改变,软件操作中的一个bug会引发数千次浪潮,一个bug会引发一个又一个的攻击。后续的变更测试不仅浪费了大量的时间和精力,而且如果与同事一起进行,可能会互相指责。但有了文件,不仅分工明确,问题出在哪里也一目了然。在我们工作之前,领导还可以提前对项目有一个大致的了解,并提前说明需要更改的内容。

对于不同的项目,文档的种类和数量也会跟着变化,越复杂的项目,也会有越多的文档,你能想象大厂一个大项目到底有多少文档吗?当然,日常工作中的普通项目,一般来说只需要几个文档就可以了,有些甚至一个就解决了。

一般文档有需求文档、测试文档、评估文档等。虽然文档没有固定格式,根据工作内容,结合实际情况,条理清晰,重点突出就可以了,但是最基本的要素还是要有的。

首先封面是必需的,不然谁也不知道你的文档到底是什么内容,同时也可以在文档上把工作顺序排好,这样也可以更有条理地工作。其次,你要做好一个目录,这个是帮助你和别人了解整个项目的流程和内容,但别告诉我一个搞技术开发的连Word目录都是手打的。如果真的不会,这里附上教程。编辑文字,点击word的引用标签,选择插入目录就可以自动生成了。

有了目录后续的工作就非常简单了,根据你的目录去添加内容就可以了,在添加内容的过程中也可以随时进行修改,相信在文档的帮助下,很多问题都能迎刃而解,工作也能事半功倍。

资源下载: