嵌入式系统的设计文档怎么写?文档的格式是? 嵌入式项目文档编写

作者&投稿:赤淑 (若有异议请与网页底部的电邮联系)
文档格式规范 1.标题分级 文档标题一般最深到5级标题,这5级标题的格式应该通过“ ”→“ ”设置。标题一律设为自动更新,表1以正文为小四号字为例说明各级标题格式,若正文是5号字,则字号相应变动。表1 标题格式列表 标题例中文字体西文字体字号首行缩进段前段后对齐方式标题11 内容黑体Arial小二不缩进各0.5行居中 标题21.1内容黑体Arial三号不缩进各0.3行左对齐 标题31.1.1内容黑体Arial四号不缩进各0.2行左对齐 标题41.内容楷体TimesNew Roman四号缩进2字符各0.2行左对齐 标题51) 内容黑体Arial小四缩进2字符各0.2行左对齐 注:(1)使用这种方法设置标题格式,是为了自动生成目录使用,一般生成到前三级。自动生成完的目录都会带有链接,同时按下“Ctrl+Shift+F9”可以去掉该链接;失去链接后的目录文字带有下划线,此时选中目录,然后按下“ ”即可去掉。目录格式也可以通过“ ”→“ ”设置。(2)检查标题是否完整。最多生成到5级进行查看。(3)标题末尾一定不要用标点符号。2.表 (1)表标题在表体上方,与不能分开。表标题应设为自动更新。表标题格式字号应比正文字号小一号。(2)表字格式单独设置。字号应比正文字号小一号。例如:宋体、Times New Roman、小五。注意表字行距、对齐方式、行高,不要太空。(3)尽量使用三线表,即左、右及中间边线是空的。为了对齐可使用白颜色的的表线。样表见表1。(4)正文中必须对文档中出现的表进行说明。(5)注意表的对齐方式,尽量使用通栏表,如表1。3.图 (1)文档中的图和图标题都必须放在四周边线是空白的表格中。注意:图标题放在图下方,图和图标题不是组合在一起的。表标题应设为自动更新。图字格式应单独设置。(2)如果要使用word图时,不要直接在原文档中绘图,而是应该另外新建一个专门用来画图的文档,在这个文档中完成该图。然后再将该图复制后,通过选择“ ”中的“图片”进行粘贴,这样可放大缩小。注意图应设为“ ”。(3)在word中画图时,若要在“ ”中插入文字时,必须设置文本框的内部边距上下左右均为0。(4)如果要在文档中插入非word图,则必须将图所在的文件转换成PDF格式,然后将该PDF放大到400%时进行截图。截图若有边线或空边可通过设置图片 边距解决。(5)正文中必须对文档中出现的图进行说明。4.正文 (1)正文格式:字体:中文-宋体,英文-Times New Roman;字号:五号或小四;首行缩进2字符(中文)。可使用18-22磅固定行距。不自动更新。(2)不使用自动编号系统!不使用“Tab”键!(3)使用公式编辑器编辑的单独公式,行距使用“单倍行距”。5.参考文献 参考文献按在正文中出现的先后次序列表于文后。文档的参考文献以[作者名 出版年]作为序号标识,如[2003王宜怀]、[2002Kegl]等。同时出现在正文与参考文献列表中。在撰写正式论文初稿的过程中,参考文献的标识方法与文档同。论文完成后,使用查找/替换方法,将文中的序号标识更换为正式序号,并对文后的参考文献的位置进行调整并排序。文献类型标识:以单字母方式标识以下各种参考文献类型:专著[M],论文集[C],报纸文章[N],期刊文章[J],学位论文[D],报告[R],标准[S],专利[P];对于论文集中析出的文献,其文献类型标识用[A];对于其他未说明文献类型,采用[Z];对于数据库、计算机程序及电子公告等电子文献类型,使用[文献类型标识/载体类型标识]:如:联机网上数据库[DB/OL],光盘图书[M/CD],网上期刊[J/OL],网上电子公告[EB/OL];格式举例:(1)专著、论文集、学位论文、报告:[序号]主要责任者.文献题名[文献类型标识].出版地:出版者,出版年,起止页码(任选).(2)期刊文章:[序号]主要责任者.文献题名[J],刊名,年,卷(期):起止页码.(3)论文集中的析出文献:[序号]析出文献主要责任者.析出文献题名[A].原文献主要责任者(任选).原文献题名[C] 出版地:出版者,出版年.析出文献起止页码.(4)国际、国家标准:[序号]标准编号,标准名称[S](5)专利:[序号]专利所有者:专利题名[P].专利国别:专利号,出版日期.(6)电子文献:[序号] 主要责任者。电子文献题名[文献类型标识/载体类型标识].电子文献的出处后可获得地址,发表或更新日期/引用日期(任选).6.其他 (1)列选中方法:按住“Alt”键的同时移动鼠标选中整列。(2)一些特殊字符有中英文2种形式,如:αβγδμπ对比αβγθμπ。前者为英文形式,通过“ ”→“ ”→“ ”→“ ”→“ ”后,选择相应西文字符插入(必须注意:设置中英文字体不同)。(3)大文档按章独立保存,小文档不分章。方法参阅:《Word 排版艺术》(侯捷著)“主文档视图”一节。(4)上划线“ ”可通过公式编辑器方式解决,注意斜体与正体。要安装数学公式编辑器。(5)若一些插入对象过高或过低,可固定行距,用字符升高或降低的方法解决。(6)要安装PDF文件生成器,文档可生成PDF格式。(7)正文不使用自动更新。(8)注意“分节符”、“分页符”、“页眉”、“页脚”、“目录”等使用方法。

[嵌入式技术] 如何规范写嵌入式系统开发文档~

一个系统设计完成以后,它不应该仅仅是一些源代码,还应该包括各种各样的开发文档。这对以后自己对系统的维护和升级都有很好的参考作用。一个系统开发完成,它究竟应该包含那些文档,这些文档一般是怎么完成的,应该包含哪些内容?这就是系统开发的规范化问题。系统开发的规范化不仅有利于自己,也有利于公司,更有利于新手。规范化的设计让工程师工作更高效,这已经是不用争论的事实。现在在大型软件工程开发方面,这已经做得相当好。但在单片机和嵌入式系统的开发方面,规范化的工作却有待我们共同探讨。在国内,一些公司的研发人员也有一种误导——快写代码,快让我看见功能,不要你做其他的,完成功能就好。这些都把我们的设计导入一种误区:大部分时间都在写代码,改代码。嵌入式实时系统复杂度的提高,设计工程师在定义和分析系统初始要求时必须认真考虑软硬件的协同关系。通常设计工程师还必须权衡系统的灵活性、速度、成本、计划和可用工具之间的关系。本文打算描述嵌入式系统和实时系统的关键特性,并探讨在选择或开发硬件和软件组件的基础上开发高效嵌入式系统的解决方案,同时详细说明嵌入式系统和实时系统开发所特有的关键工艺技术。我所知的realtime-uml的设计软件:TNI公司的ControlBuild Embedded ,Rational :Rose RTiLogix :RhapsodyArtisansw :Artisan StudioTelelogic :Tau.TNI公司的ControlBuild Embedded全流程解决方案,涵盖了整个嵌入式控制软件设计的全部过程:从用户需求、规格说明、设计、代码生成、仿真校验直到验收。在设计的最初阶段使用可执行的(形式化的)、可视化的规格说明书和用户进行沟通,消除设计人员和用户之间的歧义。利用仿真对设计进行校验测试,并在整个设计过程中进行递进式的校验,在设备安装之前发现可能存在的大量设计错误和问题,大大缩短现场调试的时间支持功能性设计, 图形化IEC61131-3 语言,符合EN50128 安全标准重复使用设计 自动生成设计文档 容易使用,快速建模 为各种软、硬件平台自动生成C 代ROSE进行分析设计RoseRT是Rational 在收购objecttime以后的推出的,该工具主要是基于一个叫做ROOM的模式,所有可执行<<active的对象都必须是一个叫做capsule的子类。其好坏我也感受不抬出来。(ilogix的道先生对ROOM不太赞同)RoseRT的界面感觉比较复杂,代码生成也可以,但效率无法评价。仅提供了系统的动态和静态模型文档。Rhapsody目前国外好多大公司都是用Rhapsody进行嵌入系统的建模,进行软件设计的。Rhapsody是一个模型驱动的开发环境,它以UML2.0为基础,使大小不同的项目都能够通过可视化建模的方法分析、设计、实现和测试自己的工作,构建和配置实时嵌入式应用。Rhapsody专为嵌入式市场的特殊需求设计和优化,包括实时系统的行为语义,实时操作系统的支持,无操作系统的实时应用支持,遗产代码的逆向工程、设计级的调试、高效的代码自动生成(C、C++、Ada、Java)和文档自动生成等。很不错的工具,可以把UML图直接转换成C++或C代码。但它也会在系统中引入它的一个程序框架,用以支持顺序图、状态图的运行、调式和仿真。它带来的好处显而易见,但同时,它对很多嵌入式应用又形成阻力。例如,如果你新增功能是在原来的已有的过程式软件包上打个补丁,新的框架和原系统的怎么配合?那么你得真正消化和吸收这个附加的框架,这个难度应该不底于探索MFC结构。对于一个完全新的项目,Rhapsody很不错。对于扩功能打补丁的项目,三思呀。不知道Rose Real-Time 在这方面的表显如何?Rhapsody 有很多 diagrams, 设计人员直接通过画图,code generation 就生成优质代码,很有意思.Rhapsody 真正把开发人员与设计人员区别开来,这就要求设计人员完全按照软件工程思想来实施,这对项目无疑是个很好的维护可以有N多的 OS adapter , 方便移植.总的来说对于开发上层应用的项目来说

你要的是,概要设计,还是详细设计文档呢?我这边有模板、、、有需要给我留言

[嵌入式技术] 如何规范写嵌入式系统开发文档
答:我所知的realtime-uml的设计软件:TNI公司的ControlBuild Embedded ,Rational :Rose RTiLogix :RhapsodyArtisansw :Artisan StudioTelelogic :Tau.TNI公司的ControlBuild Embedded全流程解决方案,涵盖了整个嵌入式控制软件设计的全部过程:从用户需求、规格说明、设计、代码生成、仿真校验直到验收。在设计的最初阶...

做系统的文档怎么写
答:1.2 陈述范围 软件描述。主要输入,过程功能,输出的描述,不考虑详细细节。1.3 软件内容 软件被置于商业或者产品线中,讨论相关的战略问题。目的是让读者能够对“宏图”有所了解。1.4 主要系统参数 任何商务软件或者产品线都包含软件规定、设计、实现和测试的说明和规范。2.0 数据设计 描...

系统设计怎么写
答:系统策划做系统设计和规则设定的;文案策划做故事情节以及任务对话剧情对话的;数值策划做的是游戏内一切数值相关的设定、关卡策划主要设计游戏中的地图、怪物、任务等,并交与美术、程序等制作,执行策划就是要将前面所说的策划案,整理成执行文档,给程序进行程序开发。 问题七:学生信息管理系统代码设计怎么写 好多语言都...

ui设计规范文档怎么写
答:规范文档是从不同的角度来服务于多种角色的 很多设计系统团队还会把自己的系统公开出来,在体现共享精神的同时也能起到吸引行业人才的作用。所以文档应该能够体现团队的专业与严谨。 文档的主要目标是:为设计师、工程师和团队里的其他角色服务,让他们能够高效地做决策。 Takeaway:设计系统的效应和影响力不只覆盖设计与...

文档怎么编辑
答:打开Word文档,首先给文档写个题目,并设置题目的字体,大小,粗细,标题居中。正文手动输入文档正文文字,单击鼠标右键,选择你想要的文字效果。文字间距,如果文字间距太密了,想把距离拉开一点好看,选定正文文字,单击鼠标右键,找到段选项,选择你想要的效果,选好后点击”确定”。插入页码,编辑完成后,...

嵌入式系统的设计流程是什么
答:系统分析员深入了解和分析需求,根据自己的经验和需求用WORD或相关的工具再做出一份文档系统的功能需求文档。这次的文档会清楚列出系统大致的大功能模块,大功能模块有哪些小功能模块,并且还列出相关的界面和界面功能。系统分析员向用户再次确认需求。2、概要设计 首先,开发者需要对软件系统进行概要设计,即...

嵌入式计算机系统的设计过程
答:1.需求分析 确定设计任务和目标,并制定说明规格文档,作为下一步设计的指导和验收标准。需求分析往往要与用户反复交流,以明确系统功能需求,性能需求,环境、可靠性、成本、功耗、资源等需求。2.体系结构设计 体系结构设计是嵌入式系统的总体设计,它需要确定嵌入式系统的总体构架,从功能上对软硬件进行...

如何写系统的使用文档
答:使用文档一般按照用户角色区分,每一种用户都有一份使用文档,常见的系统有前端,后台两个大块,即分为后台管理员使用说明书和用户使用说明书,如系统较大,比如OA系统,后台可以继续拆分,如财务人员使用说明书,crm管理员使用说明书,业务管理员使用说明书等等。正规的文档的格式,可以按以下的结构去写,...

需求文档怎么写?我想叫人帮我画板子然后送去打样?(51单片机,ARM,嵌入式...
答:文档需要体现:1,电路板的尺寸规格,比如材质要求、面积、形状、板厚、最小线宽、最小线距、单面制板还是双面或是多层制板、定位孔位置及定位孔尺寸等等;2,元器件封装,普通插式元件还是贴片封装元件,是0805封装还是0603或是...;3,接口形式。是焊盘还是插座、用什么规格的插座;4,有什么特殊的...

如何写好项目方案设计文档
答:事实上,撰写项目规划和设计文档,最重要的不是文档的模版和格式,而是里面的具体内容,它往往需要结合实际客观环境因素来综合考虑,平衡取舍,是一个需要充分脑力活动的工作。尽管如此,在大多数情况下,还是有一些相对通用的指导原则可以帮助我们更好的完成这项工作。 首先,需要有明确项目背景,目标,以及核心需求分析 换句话...