【技术文档开发工作内容|工作职责|技术文档开发做什么】-看准网

技术文档开发工作职责

英文称为Technical Documentation
从业者称为Technical writer
技术文档分两类，一类指开发中要用到的研发文档，一类是给客户看的客户文档。
研发文档
指研发过程中使用的文档。英文一般称为Specification。
文档中详细记录产品的研发目的，开发阶段，研发时限等。阅读对象一般为了解项目，有一定基础的工程师。文档作为项目执行的参考，为项目的如期完成，项目质量跟踪，以及项目的后续发展等问题提供了可依据的文字上的依据。
客户文档
指产品发布以后，公布给用户使用的文档。英文一般称为Customer Documentation。
文档详细解释产品的具体使用方法，安全提示，客户服务信息等。阅读对象一般为用户，技术支持工程师，售后服务人员。文档作为产品和市场接轨的桥梁，为产品的在市场上赢得客户的青睐，以及产品的长期发展做出了良好的保障。
技术文档的要求
技术文档要符合以下要求：
1 针对性
文档编制以前应分清读者对象，按不同的类型、不同层次的读者，决定怎样适应他们的需要。
① 对于面向管理人员和用户的文档，不应像开发文档(面向软件开发人员)那样过多地使用软件的专业术语。难以避免使用的词汇，应在文档中添加词汇表，进行解释。
② 开发文档使用的专业词汇未被广泛认知的，应添加注释进行说明。
③ 缩写词未被广泛认知的，应在其后跟上完整的拼写。
2 正确性
① 没有错字，漏字。
② 文档间引用关系正确。
③ 文档细节(Title/History)正确。
3 准确性
① 意思表达准确清晰，没有二义性。
② 正确使用标点符号，避免产生歧义。
4 完整性
① 意思表达完整，能找到主语、谓语、宾语，没有省略主语，特别是谓语。
② 一句话中不能出现几个动词一个宾语的现象。
③ 不遗漏要求和必需的信息。
5 简洁性
① 尽量不要采用较长的句子来描述，无法避免时，应注意使用正确的标点符号。
② 简洁明了，不累赘冗余，每个意思只在文档中表达一次。
③ 每个陈述语句，只表达一个意思。
④ 力求简明，如有可能，配以适当的图表，以增强其清晰性。
6 统一性
① 统一采用专业术语和项目规定的术语集。
② 同一个意思和名称，前后描述的用语要一致。
③ 文档前后使用的字体要统一。
④ 同一课题若干文档内容应该协调一致，没有矛盾。
7 易读性
① 文字描述要通俗易懂。
② 前后文关联词使用恰当。
③ 文档变更内容用其他颜色与上个版本区别开来。
④ 测试步骤要采用列表的方式，用1)、2)、3)…等数字序号标注。

查看全文

技术文档开发热门招聘

查看全部

收藏
立即投递

[成都] 技术文档工程师

职位薪资：6-10K 经验：1-3年学历：大专类型：全职

工作职责： 1、协助完成新产品设计开发资料并整理成册； 2、协助完成新产品注册审核相关工作； 3、协助完成取证产品的研发体系维护工作，包括工艺、设备的验证相关工作； 4、领导安排的其他工作。任资要求： 1、大专统招及以上学历，机械、电子、材料、化工等相关等相关专业 2、熟悉医疗器械设计开发控制程序，有设计开发资料编写或者审核经验； 3、熟悉ISO 9001:2008、ISO13485：2016、医疗器械生产质量管理规范、MDD 93/42/EE（2007/47/EC）等医疗器械相关法律和法规的要求； 4、医疗器械行业体系工程师相关工作经验或医药行业相关工作经验。上班时间：8:30-17:30（大小周休息）
收藏
立即投递

[深圳] 充电桩技术文档工程师

职位薪资：10-15K 经验：3-5年学历：本科类型：全职

1、负责编写、维护和更新充电桩相关的技术文档，包括但不限于产品说明书、操作手册、安装指南等。 2. 根据产品开发进度，对技术文档进行相应的修改和完善，确保文档的准确性和时效性。 3. 协助研发团队完成充电桩的技术支持和文档编写，解答客户的技术问题，提供专业的技术支持。 4. 负责技术文档的校对和审核，确保文档的质量和规范性。 5. 参与充电桩的测试和验收工作，了解产品的性能和特点，为编写技术文档提供依据。 6. 关注充电桩行业的技术动态和标准发展，及时了解新技术、新标准和新规范，不断提升自身的技术水平。 7. 协助市场营销部门，为充电桩的市场推广提供必要的技术支持。 8、电源相关、电气类背景优先。 8. 完成领导交办的其他相关工作。
收藏
立即投递

[深圳] FAE 现场应用工程师/技术文档工程师

职位薪资：8-13K 经验：1-3年学历：大专类型：全职

1、负责公司产品相关的技术支持工作：现场技术问题反馈及处理、技术咨询、服务数据整理/统计分析、客户回访； 2、负责公司新产品、新技术的推广，并收集市场需求及产品优化建议； 3、负责现场问题排查及处理，缺陷鉴别与反馈； 4、负责客户定制项目的对接并跟进研发团队进度，协助客户对客户产品进行联合调试；协助销售维护客户关系，并提供售前方案支持； 5、负责公司产品的演示及技术培训工作。 *良好的办公环境：公司位于深圳市平湖华南城，甲级写字楼，一流的办公环境； *丰厚的薪资奖励：试用期底薪+提成+多形式额外奖金； *广阔的发展空间：畅通的晋升通道，提高专业和管理双向发展渠道，表现优秀者有出国机会；同时提供多种形式内容丰富的员工培训：入职培训、职业发展培训、管理技能培训、专业技术能力培训、英语培训老外亲自授课等。任职资格：1、电子类、通信类、计算机相关专业本科及以上学历（优秀者可放宽至专科学历），22－28岁； 2、电子、IT或通信行业一年以上相关（偏硬件方向）工作经验； 3、优秀应届毕业生亦可，参与过技术竞赛类活动优先考虑； 4、有较强的逻辑思维能力和沟通能力；有强烈的责任心及团队合作精神； 5、接受出差。
收藏
立即投递

[成都] 资深研发工程师/技术专家

职位薪资：20-35K·16薪经验：3-5年学历：本科类型：全职

职位描述: 1、根据业务需求，独立完成 iOS/android 客户端程序的开发； 2、参与移动平台软件框架的研究，设计和实现、关键技术验证和选型等工作，独立负责过客户端整体或者核心模块的设计; 3、对产品进行持续优化和改进，对App性能、安全、容器、工程方面持续优化提升； 4、参与移动规范制订、技术文档编写。职位要求: 1、本科及以上学历，三年及以上手机应用实际开发经验，技术视野开阔，学习能力好，对业界新技术敏感，喜欢钻研，具有良好的学习能力并注重团队合作； 2. 精通Android/iOS 各种特性，熟练各种UI组件并了解其内部原理，有通过源码阅读定位问题的经验，熟悉主流的开源组件以及框架，能处理常见大型项目的问题； 3. 熟悉 Hybird开发（H5/React Native）等技术原理，有前端开发经验者加分； 4. 有良好的开发基础，对设计模式有较好的理解，能在实际产品中很好的运用； 5. 沟通能力强，有较强的自我驱动力和快速学习能力。责任心强，具备良好团队合作精神； 6. 对无线技术有持续的热情，个性乐观开朗，逻辑性强，善于和不同技能背景的团队合作； 7. 具备英语表达能力，有国际化工作经验优先。阿里巴巴集团的使命是让天下没有难做的生意。我们旨在赋能企业改变营销、销售和经营的方式。我们为商家、品牌及其他企业提供基本的互联网基础设施以及营销平台，让其可借助互联网的力量与用户和客户互动。我们的业务包括核心电商、云计算、数字媒体和娱乐以及创新项目和其他业务。我们并通过子公司菜鸟网络及所投资的关
收藏
立即投递

[上海] GIS技术架构师

职位薪资：35-65K 经验：5-10年学历：本科类型：全职

工作内容： 1．负责搭建二三维 GIS 平台系统，包括底层架构设计，数据库设计； 2．负责 GIS 平台和产品的技术方向规划、技术难题攻关、新技术预研； 3．负责系统的架构设计、核心模块编码、测试、部署维护及相关文档编写工作； 4．负责空间数据的管理、规划、设计和应用； 5．负责开发人员的培训指导； 6．负责人员组织协调、项目推进、管控工作。 7．了解业界核心技术，并推动产品新特性设计开发； 8．参与产品构思和架构设计，撰写相关的技术文档； 9．分析并解决软件研发过程中的问题任职要求： 1．本科或以上学历、计算机或 GIS 相关专业，从事 GIS 行业 5 年以上，具有 GIS 平台架构设计经验； 2．熟悉地图数据服务，包括空间数据库、导航、地图渲染、信息搜索、 OGC 服务等技术，参与过业界主流 GIS 系统平台设计； 3．精通 GIS 行业应用的主流数据分布式存储方案，包括 Oracle、 PostgreSQL、MySQL、DFS、Oracle、NoSql 等数据库； 4．具备扎实的 JAVA 基础，熟悉微服务框架，了解 SOA 架构理念等； 5．精通 HPC 或云系统架构设计开发及调优； 6．熟悉空间数据引擎及空间数据的管理及融合应用，了解云 GIS； 7．成熟 GIS 应用系统架构设计开发经验； 8．熟悉开源 GIS 大数据平台技术路线； 9．具有较强的领导能力和沟通协调能力，善于团队作战
收藏
立即投递

[北京] JAVA技术专家/架构师

职位薪资：40-70K·16薪经验：5-10年学历：本科类型：全职

股票
收藏
立即投递

[深圳] 腾讯文档后台开发工程师

职位薪资：25-50K·16薪经验：1-3年学历：本科类型：全职

岗位职责： 1、负责腾讯文档后台功能开发及私有化、SAAS 版本的建设，助力文档相关规模/营收目标的达成； 2、参与腾讯文档海量后台的架构设计和实施，持续提升和保障后台服务的可用性及性能； 3、负责跟踪业界前沿技术进展，并且能够快速应用到业务中。岗位要求： 1、本科以上学历，计算机相关专业，2 年以上 Unix/Linux 下 C/C++/Golang/Java/Rust 开发经验，熟悉面向对象设计； 2、熟悉多进程多线程编程，熟悉 TCP/IP，熟悉 Linux 网络编程和高并发设计范式； 3、熟悉Mysql数据库，熟悉NoSQL存储； 4、热爱技术，有较强的学习意愿与能力，具备良好的分析解决问题能力，能独立承担任务，有项目进度把控能力； 5、了解文档等办公 SAAS 系统或有相关经验者优先。
收藏
立即投递

[深圳] 前端开发工程师-飞书文档_【深圳_E2535】

职位薪资：25-50K·15薪经验：3-5年学历：本科类型：全职

六险一金、弹性工作、带薪休假、租房补贴、免费三餐及下午茶
收藏
立即投递

[深圳] 腾讯文档后台开发工程师

职位薪资：25-50K·16薪经验：1-3年学历：本科类型：全职

岗位职责： 1、负责腾讯文档后台功能开发及私有化、SAAS 版本的建设，助力文档相关规模/营收目标的达成； 2、参与腾讯文档海量后台的架构设计和实施，持续提升和保障后台服务的可用性及性能； 3、负责跟踪业界前沿技术进展，并且能够快速应用到业务中。岗位要求： 1、本科以上学历，计算机相关专业，2 年以上 Unix/Linux 下 C/C++/Golang/Java/Rust 开发经验，熟悉面向对象设计； 2、熟悉多进程多线程编程，熟悉 TCP/IP，熟悉 Linux 网络编程和高并发设计范式； 3、熟悉Mysql数据库，熟悉NoSQL存储； 4、热爱技术，有较强的学习意愿与能力，具备良好的分析解决问题能力，能独立承担任务，有项目进度把控能力； 5、了解文档等办公 SAAS 系统或有相关经验者优先。
收藏
立即投递

[北京] Android研发工程师

职位薪资：15-30K 经验：1-3年学历：本科类型：全职

工作职责: -负责医美产品Android端相关产品研发和迭代工作 -参与产品设计，按照设计规范，完成技术文档编写 -对Android性能、内存优化、疑难问题分析与解决 -参与移动平台软件框架的研究，设计和实现、关键技术验证和选型等工作职责要求: -计算机软件、通讯等相关专业本科及以上，2年以上Android开发经验，熟练掌握kotlin者优先 -精通Java语言，熟悉Android SDK和NDK，及Android平台体系结构 -熟悉Android的线程机制，能够熟练使用各种Android系统的线程类，及Service、广播等 -熟悉Android Framework层，有通过Android源码阅读定位问题经验 -具有Android应用架构经验，至少参与过一个完整应用的技术框架搭建、关键技术选型工作 -对移动应用开发、安全的应用层协议设计及相关垂直技术领域有良好理解和掌握 -有开源项目、技术博客者优先 -优秀的逻辑思维能力和分析问题、解决问题的能力，对解决具有挑战性问题充满激情 -具备强烈的进取心和责任感, 极强的学习能力及良好的团队合作精神

技术文档开发工作内容

技术文档开发工作职责

技术文档开发热门招聘

技术文档开发热门公司面试