技术作家
Technical Writer
Intetics Inc. 是一家全球科技公司,专注于定制软件应用开发、分布式工程团队、软件质量工程和创新的数字化转型解决方案,现正寻找一位技术娴熟且经验丰富的技术作家加入我们的全职团队。
描述
作为技术作家,您将与软件工程师、产品经理和其他利益相关者紧密合作,创建世界级的技术文档。您将把复杂的云技术、API、开发者工具和基础设施服务转化为清晰、简洁且易于使用的内容,从而推动客户成功和产品采用。
职责
- 维护并持续改进公司知识库,确保文档准确、最新且易于访问。
- 建立并维护文档标准、风格指南、模板和最佳实践,以确保所有内容的一致性。
- 设计并优化文档结构、导航和信息架构,以提升用户体验和内容可发现性。
- 管理并增强文档工具链,包括版本控制系统、静态站点生成器和发布流程。
- 创建高质量的技术内容,包括开发者指南、API 文档、教程、版本说明和产品文档。
- 与软件工程师和产品经理密切合作,收集技术信息并确保内容准确性。
- 将复杂的 technical concepts、云架构、微服务和 REST APIs 转化为清晰易懂的文档。
- 在敏捷开发环境中计划、跟踪并交付文档项目。
- 分析文档使用指标和用户反馈,识别不足并持续提升内容质量。
- 监控支持工单、社区渠道和用户反馈,主动应对文档需求。
- 与内部团队合作,开发用于教育视频材料的脚本和内容。
- 要求
- 3 年以上为开发者、软件产品或 IT 专业人士编写技术文档的经验。
- 计算机科学、技术传播、英语或相关领域的学士学位。
- 强大的技术能力,能够理解软件开发概念、API 和编程语言。
- 能够阅读和理解用多种编程语言编写的源代码。
查看英文原文
Intetics Inc., a global technology company specializing in custom software application development, distributed engineering teams, software quality engineering, and innovative digital transformation solutions, is seeking a highly skilled and experienced Technical Writer to join our growing team on a full-time basis.
Description
As a Technical Writer, you will work closely with Software Engineers, Product Managers, and other stakeholders to create world-class technical documentation. You will transform complex cloud technologies, APIs, developer tools, and infrastructure services into clear, concise, and user-friendly content that drives customer success and product adoption.
Responsibilities
- Maintain and continuously improve the company knowledge base, ensuring documentation remains accurate, up-to-date, and easily accessible.
- Establish and maintain documentation standards, style guides, templates, and best practices to ensure consistency across all content.
- Design and optimize documentation structure, navigation, and information architecture to improve user experience and content discoverability.
- Manage and enhance documentation toolchains, including version control systems, static site generators, and publishing workflows.
- Create high-quality technical content, including developer guides, API documentation, tutorials, release notes, and product documentation.
- Collaborate closely with software engineers and product managers to gather technical information and ensure content accuracy.
- Translate complex technical concepts, cloud architectures, microservices, and REST APIs into clear and understandable documentation.
- Plan, track, and deliver documentation projects within Agile development environments.
- Analyze documentation usage metrics and user feedback to identify gaps and continuously improve content quality.
- Monitor support tickets, community channels, and user feedback to proactively address documentation needs.
- Develop scripts and content for educational video materials in collaboration with internal teams.
Requirements
- 3+ years of experience creating technical documentation for developers, software products, or IT professionals.
- Bachelor's degree in Computer Science, Technical Communication, English, or a related field.
- Strong technical aptitude with the ability to understand software development concepts, APIs, and programming languages.
- Ability to read and understand source code written in languages such as Python, Java, JavaScript, or similar.
- Excellent written and verbal communication skills in English.
- Experience producing clear, well-structured technical content for both technical and non-technical audiences.
- Experience using Git/GitHub for version control and collaborative documentation workflows.
- Proficiency with Markdown, reStructuredText, or similar markup languages.
- Familiarity with API documentation tools such as OpenAPI/Swagger and Postman.
- Experience with documentation platforms such as Confluence, GitBook, Read the Docs, Document360, or similar solutions.
- Understanding of SEO principles and analytics tools for measuring documentation effectiveness.
- Experience documenting cloud-based platforms, SaaS products, developer tools, or enterprise software solutions.
- Familiarity with Agile methodologies and project tracking tools such as Jira.
Nice to Have
- Experience creating or supporting technical video tutorials and educational content.
- Experience with CI/CD pipelines and modern documentation publishing workflows.
- Understanding of cloud infrastructure and distributed systems concepts.
- Experience working in product-focused or developer-focused environments.
Originally posted on Himalayas