As a Technical Writer, you'll own documentation for key areas of the Camunda platform, collaborating with product teams to ensure clarity and accuracy while maintaining the documentation infrastructure.
Technical Writer
📜 Description
- 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.
🛠️ 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.
Full job description
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.
Similar jobs
Search more Technical Writer jobsAs a Technical Writer, you will create and maintain clear documentation for an enterprise SaaS product, collaborating with various teams to enhance customer understanding and support.
As a Technical Writer for PostgreSQL, you will create comprehensive documentation, collaborate with teams, and leverage AI tools to enhance user understanding and adoption of our products.
Join the Docs Excellence team as a Technical Writer, where you'll design metadata schemas and curate technical content to enhance developer documentation.
Technical Writer (Remote Opportunity)
The Technical Writer will coordinate and create complex technical documents, ensuring clarity and adherence to guidelines while supporting the Department of Veterans Affairs' data migration efforts.
