职位描述
作为技术文档工程师，您将负责创建和维护全面的产品文档，帮助用户和开发者高效使用我们的软件解决方案。该职位需要与跨职能团队紧密合作，通过用户手册、教程、API规范和SDK文档等多种形式交付准确及时的信息。您将在敏捷开发环境中工作，确保文档内容与产品功能演进和用户需求保持同步，为开发生命周期的整体成功做出贡献。理想的候选人还将负责统筹管理全公司的技术信息资产，确保所有利益相关者都能获取一致且规范的技术内容。
核心职责
- 编写和维护产品文档（包括用户手册、API参考和SDK指南），确保技术与非技术受众都能清晰理解
- 开发教程和分步指南等入门材料，帮助用户和开发者快速掌握产品集成方法
- 与工程师、产品经理和QA团队密切协作，收集需求、验证技术细节，确保文档反映最新产品动态
- 使用OpenAPI/Swagger等行业标准工具创建和更新API规范，支持集成与开发工作流
- 协调各部门利益相关者，收集、整理并集中管理技术信息，维护统一的知识库
- 开展用户调研发现文档缺口，通过针对性内容更新优化用户体验
- 审核修订现有文档，确保内容准确性、一致性并符合公司标准和品牌规范
- 参与敏捷站会和迭代回顾，确保文档开发与项目进度同步
- 设计直观可扩展的文档架构，同时满足内部团队和外部客户需求
- 通过Confluence等集中化平台实施文档版本控制，确保内容可检索、易获取
任职要求
- 具备技术文档工程师或相关岗位经验，有高质量技术文档作品集
- 出色的中英文书面与口头表达能力，擅长将复杂技术概念转化为清晰易懂的表述
- 熟练使用Markdown、Confluence等文档工具及Git版本控制系统
- 深入理解API设计原则，能编写RESTful服务和SDK的详细规范
- 适应敏捷快节奏环境，既能独立工作又可团队协作，在紧迫时限内保证交付质量
- 掌握以用户为中心的设计方法，能编写提升用户体验和产品采纳率的文档
- 对技术细节保持严谨态度，确保文档信息准确无误
- 熟悉Swagger等支持自动化生成的文档框架工具
- 具备访谈技术团队获取需求、澄清复杂概念的能力
- 优秀的组织能力，可同时管理多个文档项目并合理分配优先级
- 理解软件开发生命周期，能使文档与产品版本更新保持同步
- 能创建并维护确保产品材料一致性的文档模板
- 具有CMS系统使用经验，能将文档发布至内外部门户
- 出色的解决问题能力，能识别文档痛点并提出创新解决方案
- 具备自主工作能力，能主动承担文档交付责任并确保按时完成
- 了解无障碍标准，能编写符合法规要求的包容性文档
- 强大的跨部门协作能力，能与各职能团队高效配合
- 有文档本地化和多语言翻译经验者优先
- 能对文档流程提出改进建议并参与持续优化
- 优秀的时间管理能力，在保证文档质量的同时严守项目节点
