技术文档工程师
岗位摘要
设计并维护文档结构与导航(快速入门/指南/API与SDK参考/示例/故障排除/常见问题解答),确保开发者能够快速找到、理解并成功操作;编写5-15分钟可运行的快速入门指南和场景化教程,覆盖核心语言和关键路径
登录后保留你的岗位线索
邮箱登录后可继续查看完整职责、任职要求和原岗位入口,并使用收藏与浏览记录沉淀适合自己的机会。
岗位职责
- 设计并维护文档结构与导航(快速入门/指南/API与SDK参考/示例/故障排除/常见问题解答),确保开发者能够快速找到、理解并成功操作
- 编写5-15分钟可运行的快速入门指南和场景化教程,覆盖核心语言和关键路径
- 维护API/SDK参考文档、参数与错误码说明,确保与产品版本、SDK发布和控制台功能同步
- 建立故障排除与自助体系,将高频问题转化为可操作的'现象→定位→根因→修复→预防'路径,并持续迭代
- 协同维护示例项目的README和使用说明,确保示例可运行、可复现、可验证,必要时推动自动化校验
- 推进文档即代码流程(PR流程、审校清单、链接/示例/版本检查、发布流程),提升交付效率与质量稳定性
- 与开发者倡导者、开发平台产品经理、SDK/CLI团队、社区和支持团队协作,将工单和社区问题转化为文档改进并跟踪效果
任职要求
- 能够理解接口与日志,具备技术写作与信息架构能力,写作严谨、结构清晰
- 拥有开发者文档经验:编写过API/SDK/平台类产品文档,理解开发者的首次成功路径与常见失败点
- 具备较强的工程协作能力:能够参与PR流程,与研发团队共同确保版本一致性和示例可运行性
- 对质量敏感:坚持可复现与一致性标准,致力于将文档打造为长期资产而非一次性交付
- 熟悉业界一流技术传播相关平台者优先
- 具备英文写作能力者优先
登录后查看完整岗位详情
使用邮箱验证码登录后,可查看完整职责、任职要求、原岗位入口,并继续使用收藏和浏览记录。列表摘要保持公开,完整详情用于保护数据质量和降低恶意抓取。