课程大纲
介绍
- 创建被使用的 Documentation
需求收集
- 如何从用户的角度查看使用说明书
- 收集和理解需求(内部和外部)
- 技术 Documentation 中应包含哪些内容以及应省略哪些内容
规划
- 规划技术写作项目
- 计划和产品生命周期
写作
- 编写最小可行草稿
- 让你的写作易于理解
- 迭代在写作过程中的重要性
2013-
- 构建文档
- 使内容 Search 可
外观
- 添加插图和图表
- 格式和布局技术
- 使用排版增强可读性
工具
- 使用技术 Documentation 工具和模板
校订
- 优化技术 Documentation 工作流程
- 正式确定审查和修订过程
译本
- 翻译和翻译过程
出版
- 发布技术文档
出版后
- 从用户那里获得反馈
- 更新和维护技术 Documentation
总结和结论
要求
- 除了拥有需要技术文档的产品、服务外,没有特殊要求。
观众
- 非撰稿人(例如,开发人员、工程师、技术经理、设计师、产品和项目经理等)
客户评论 (5)
I am getting the correct level of understanding I need to assist in my day to day work
Wasfi Adams
课程 - Impacted Function Point (IFP)
Everything was built up from a basic level while progressing quick enough to prevent anyone getting bored.
Nathan Roberts
课程 - Software Engineering
The trainer was super engaging and made sure we understand through questioning and affirmations. Even though the content was overwhelming, the trainer broke it down well and made content easily accessible for later reference.
Zaid Amerika
课程 - Unit of Software Measurement Parameterization (UMSP)
the examples the trainer used in each subject which made it easier to understand
huda Alyassi - Dubai Government Human Resources Dept.
课程 - Adobe XD
培训师真的很友善,知识渊博,不厌其烦地解释我不知道的事情
Felix - Microchip Technology Inc
课程 - Embedded C Application Design Principles for Automotive Professionals
机器翻译