Job Description
We are seeking a skilled Technical Writer to create clear, accurate, and well-organized content that will help our users and developers understand complex concepts and technical features.
- In this role, you will be responsible for writing API documentation, assisting with API design, and working closely with cross-functional teams to ensure that our product documentation meets the needs of developers, IT professionals, and other stakeholders.
Key Responsibilities
- Write clear, accurate, and comprehensive documentation for APIs and software features.
- Ensure documentation is well-organized, consistent, and highly effective for the target audience (developers, IT professionals, DevOps, etc.).
- Use Markdown, GitLab, OpenAPI, Docs as Code, and similar tools to produce and maintain content.
- Create technical content that is easy to understand, while explaining complex technical concepts in context.
- Work closely with developers, designers, product managers, and other stakeholders to gather information and ensure documentation is aligned with product features and upcoming changes.
- Actively engage in agile development team meetings, representing the interests of the product documentation team.
- Collaborate across functions to ensure documentation aligns with other customer enablement materials, such as user guides or tutorials.
- Test product features and workflows to become an expert user and provide insightful feedback to product development teams.
- Participate in user testing and documentation review processes to continuously improve content quality and accuracy.
Required Skills
- 4+ years of experience as a technical writer, particularly for developers, security experts, IT operations, or DevOps audiences.
- A Bachelor’s degree in technical writing, communications, computer science, English.
- proficiency in English
- quickly learn complex technical concepts and communicate them clearly
- Docs as Code, GitLab, OpenAPI, and Markdown.
- information design and content creation
Preferred
- cloud technologies, APIs, or DevSecOps tools.
- Docusaurus, Swagger
- version control and continuous integration tools
Hiring Team Member
