技术文档的技术描述怎么写

⑴ 技术交底书应该怎么写

发明/实用新型专利申请技术资料交底要求：
1.名称：简明表述要保护的主题名称，名称应体现是产品或方法（一般25个字以内）。
2.所属技术领域：说明本申请所属或直接应用的具体技术领域，不是上位或相邻的技术领域。
3.背景技术：对本申请最接近的现有技术状况加以说明（必要时借助附图加以说明），要指明来源或出处，客观分析其存在的问题及原因（应针对本申请能够解决的问题而言）。简单说，说明与本申请最接近的现有技术的方案是什么，并阐述其存在的缺陷，该缺陷须是本申请能够克服的缺陷。
4.发明目的：阐述本申请所解决技术问题，应采用正面语句，尽可能直接、清楚和简洁，这一技术问题是针对最接近现有技术所实际解决的问题。简单说，本申请能解决什么问题。
5.技术方案：详细描述该申请的主要技术方案，针对不同领域的专利，分别采用如下方式来描述其主要技术方案：简单说，本申请的技术凭什么比别人好，怎么做的，为什么？可提供结构、流程、方法、配方等来描述技术原理。
6.本申请的有益效果：详细说明本申请所能完成的任务及其与现有技术相比所具有的优点，并给出该优点的产生来自于技术方案的哪一部分。
7.附图及附图说明：附图中一般不标注尺寸，尽量不使用文字，各部件的标号应采用阿拉伯数字编写。
8.实施方式：详细描述实现本申请的具体实施方式（有附图的应对照附图进行解释，但附图不能代替文字说明）。

⑵ java web 技术文档怎么写

如果只是要描述这个程序的结构与使用的到的技术相对来说比较简单点..
你如果代码进行MVC的这种模式的 你可以进行分层描写，各层用到了什么技术框架..还有使用到框架中的某些功能，列举一个类似功能清单之类的介绍文档就可以了

⑶ 主要技术文件目录及来源 怎么写

主要技术文件目录及来源格式：

项目名称：

项目负责人：

项目单位：

联系电话：

办公：

手机：

起止时间：

批准金额：

填表日期：

内蒙古医学院科技处制二零零七年十二月。

一、项目摘要。

二、项目研究执行情况概述。

三、项目研究工作主要进展及所取得成果。

四、成果转化情况，取得的经济、社会效益（附证明材料）。

五、国内外学术合作交流及人才培养情况。

六、存在问题、建议及其它需要说明的情况。

七、下一步的打算与研究计划。

八、经费使用情况九、项目负责人签字及审核意见附表1内蒙古医学院科研项目研究成果目录（栏目不够可自行增加）注：

1、“成果类型”栏，分为“专着/期刊论文/会议论文/专利/获奖/其他”六类，请归类集中填写并单独编号；

2、“成果说明”栏，用于填写如刊物名、获奖类别、级别等必要的说明和便于其他人查询的信息等；

3、“备注”栏，用于说明成果是否标注“内蒙古医学院重大(青年)科研项目基金资助”及项目批准号等。

(3)技术文档的技术描述怎么写扩展阅读：

资信部分包括公司资质，公司情况介绍等一系列内容，同时也是招标文件要求提供的其他文件等相关内容，包括公司的业绩和各种证件、报告等。

技术部分包括工程的描述、设计和施工方案等技术方案，工程量清单、人员配置、图纸、表格等和技术相关的资料。

商务部分包括投标报价说明，投标总价，主要材料价格表和合同条件（通用和专用）等。

技术文件的修改必须按级、按各职能部门的业务分管范围执行。

技术文件修改前，负责修改部门要提出修改理由及具体内容，交有关领导审批。

⑷ 技术文档的技术文档的要求

技术文档要符合以下要求：
1.针对性
文档编制以前应分清读者对象，按不同的类型、不同层次的读者，决定怎样适应他们的需要。
① 对于面向管理人员和用户的文档，不应像开发文档(面向软件开发人员)那样过多地使用软件的专业术语。 难以避免使用的词汇，应在文档中添加词汇表，进行解释。
② 开发文档使用的专业词汇未被广泛认知的，应添加注释进行说明。
③ 缩写词未被广泛认知的，应在其后跟上完整的拼写。
2.正确性
① 没有错字，漏字。
② 文档间引用关系正确。
③ 文档细节(Title/History)正确。
3.准确性
① 意思表达准确清晰，没有二义性。
② 正确使用标点符号，避免产生歧义。
4.完整性
① 意思表达完整，能找到主语、谓语、宾语，没有省略主语，特别是谓语。
② 一句话中不能出现几个动词一个宾语的现象。
③ 不遗漏要求和必需的信息。
5.简洁性
① 尽量不要采用较长的句子来描述，无法避免时，应注意使用正确的标点符号。
② 简洁明了，不累赘冗余，每个意思只在文档中表达一次。
③ 每个陈述语句，只表达一个意思。
④ 力求简明，如有可能，配以适当的图表，以增强其清晰性。
6.统一性
① 统一采用专业术语和项目规定的术语集。
② 同一个意思和名称，前后描述的用语要一致。
③ 文档前后使用的字体要统一。
④ 同一课题若干文档内容应该协调一致，没有矛盾。
7.易读性
① 文字描述要通俗易懂。
② 前后文关联词使用恰当。
③ 文档变更内容用其他颜色与上个版本区别开来。
④ 测试步骤要采用列表的方式，用1)、2)、3)…等数字序号标注。

⑸ 作为程序员如何书写技术文档

按自己的喜好去写,没有具体的格式,不过要写名程序的用途,代码的函数使用方法,变量的意义等内容

⑹ 项目技术说明文本 要怎么写

我不是ic行业的，我只是搞项目管理的。你的技术说明做什么用途？你是项目的实施承包方还是项目的设计方或者是业主方？
一般来说，业主会向设计单位提交项目的设计任务书，里面就有技术说明的内容。主要是向设计单位提出项目的功能要求、设备要求、技术参数、材料要求等等，也有要求工艺过程、施工办法等等。
设计单位的设计文件里面有设计说明，设计上是对设计图形文件的补充文字说明，叫技术说明也对。
项目的施工单位一般没有技术说明。但是，如果你的项目小，业主（出钱建设的老板）可以不要设计单位，让一个单位即承担设计，又承担施工。这样设计说明仍然由你来搞。内容同上。