职位描述:
作为一名专注于API文档的技术写作人员,您将负责为开发人员和其他技术利益相关者创建清晰、简明和用户友好的文档。您将与软件工程师和产品经理合作,了解和解释复杂的技术信息,并将其转化为易于理解的文档。您出色的写作技巧、注重细节的能力以及有效传达复杂概念的能力将有助于软件集成和开发项目的成功。
职责:
• 创建和维护API文档,包括用户指南、技术参考、API参考文档和常见问题解答。
• 与软件工程师和产品经理合作,收集信息并了解技术要求。
• 将技术信息转化为面向开发人员和技术受众的清晰简明的文档。
• 通过进行全面的技术审查确保文档的准确性和完整性。
• 组织和结构化文档以提高可用性和可访问性。
• 使用图表、流程图和代码片段来阐述复杂的概念和流程。
• 更新文档以反映产品的更新、变更和增强。
• 与跨职能团队合作,使文档与产品路线图和发展保持一致。
• 参与API的测试和验证,以确保准确的文档。
• 持续了解API文档和技术写作的行业标准和最佳实践。
要求:
• 计算机科学、技术写作或相关领域的学士学位。
• 作为专注于API文档的技术写作人员的经验。
• 对API、编程语言和软件开发概念有深入的了解。
• 出色的书面和口头沟通能力。
• 熟练使用Swagger、Postman或DocuSign等文档工具和软件。