How to write a good design document for peer engineers (如何写一份给工程师看的技术文档)
来源:互联网 发布:数据分析与知识发现 编辑:程序博客网 时间:2024/05/24 04:07
Content comes from: http://blog.slickedit.com/2007/05/how-to-write-an-effective-design-document/
第一部分:阐述你的工程需要解决什么问题,目标的用户是谁。同时,通过写这个部分,你可以知道你的目标工程是否合理且有存在的意义。
第二部分:从high level去阐述这个工程的构成部分有哪些,简要介绍他们的功能。这里需要用到entity diagram去阐述。例如:
第三部分:详细地介绍每个模块的内容。如果这个模块是某个接口的实现类,就可以在这里详细叙述。
通常需要叙述的内容:1/ 用一段介绍其usage,不需要be verbose. 2/ 是否有什么special configuration,这里可以讲述下一些特殊的函数参数的作用。 3/ 用类UML去介绍下这个模块的类族。
例如:
第四部分:Interaction Diagram. 当前模块之间的通信图。例如:
第五部分:阐述下总体的benefit 和 risk.
阅读全文
0 0
- How to write a good design document for peer engineers (如何写一份给工程师看的技术文档)
- How to Write an Effective Design Document
- How to write a good build system ?
- How to write a good bug?
- How to write a good bug report
- 如何写每周工作报告(How to Write a Weekly Report)
- 如何写科技论文How to write a technical paper
- How (and How Not) to Write a Good Systems Paper
- 如何写一个UEFI EDKII的应用:how to write a UEFI EDKII application
- 如何写投稿信 (How to write a cover letter)
- How to write a good bug report? Tips and Tricks
- How to write a good bug report? Tips and Tricksa
- How to write good essay
- How to Write Good Requirements
- How to Design a Good API and Why it Matters
- How to Design a Good API and Why it Matters
- How to Design a Good API and Why it Matters
- 7 TIPS How to Become a Good Hardware Design Engineer
- 设计模式-9-桥接模式
- 青蛙跳台阶
- 网络的基本设定
- opencv3.2.0在vs2015,2017中的环境配置
- lua中关于取长度问题
- How to write a good design document for peer engineers (如何写一份给工程师看的技术文档)
- android NDK如何解决Please define the NDK_PROJECT_PATH variable to point to it
- 图解FTP的主动模式与被动模式以及客户端设置
- Android Things:外设I/O接口-GPIO
- 【C++】对象模型
- 三维迷宫
- Android 程序以及在4.4.4以上报错但是在4.4.4以上不报错
- 二叉堆
- [机器学习入门] 李宏毅机器学习笔记-29 (Sequence Labeling Problem part 1;结构化预测-序列标记 part 1)