【职位描述】 作为关键信息的载体,有必要使用自动化流程保证技术文档中信息的同步、准确、一致。作为技术文档实习生,你将:
1.了解MCU设计、软件SDK开发、最终用户手册发布过程中的关键信息。
2.根据相关需求编写脚本,对关键信息进行DRC检查。
3.了解关键信息的来源(生产者)和去向(消费者),以及他们对信息呈现方式的需求
4.利用自动化脚本、自动化平台工具,使用CI/CD方法等改进关键信息在各团队功能间的流动方式
5.参与文档内容编写
【技能要求】
1.硕士及以上学历, 计算机或微电子专业优先
2.良好的沟通和表达能力,善于跨团队协调沟通
3.熟悉Python编程语言,了解XML标准
4.了解或有兴趣学习Jenkins等CI/CD自动化平台,Conference知识库的使用
5.了解或有兴趣了解DITA标准,DITA-OT
6.了解微控制器单元(MCU)者优先
技术文档工程师
工作职责
1.协助技术文档工程师收集产品相关技术信息,包括产品功能、操作流程、技术参数等,与研发、测试等部门沟通确认细节,确保信息的准确性和完整性。
2.参与技术文档的撰写与编辑工作,如产品使用手册、安装指南、API 文档等,按照公司文档规范和格式要求,完成文档的初稿撰写、内容补充和格式调整。
3.对已完成的技术文档进行校对和审核,检查文字表述、逻辑结构、技术术语使用等方面是否存在问题,提出修改建议并协助完善,保证文档质量。
4.协助进行技术文档的版本管理,记录文档的更新历史、修改内容和版本号,确保各版本文档的有序存储和便捷查询。
5.参与文档相关的辅助工作,如收集用户对技术文档的反馈意见,整理并反馈给相关负责人;协助制作文档配套的图示、截图等素材,提升文档的可读性和易用性。
6.完成上级领导交办的其他与技术文档相关的临时性工作任务。
任职要求
1.学历与专业:硕士及以上学历,计算机科学与技术、电子信息工程、软件工程、英语等相关专业优先,研一、研二学生均可。
2.技能要求
(1)具备良好的文字表达能力和逻辑思维能力,能够清晰、准确地组织和呈现技术内容。
(2)熟悉常用的办公软件,如 Word、Excel、PowerPoint 等,会使用 Markdown、Adobe Acrobat 等文档编辑工具者优先。
(3)对技术文档撰写有一定的兴趣和认知,了解技术文档的基本规范和写作方法。
(4)具备基本的英语阅读能力,能够读懂英文技术资料和文档