We appreciate your interest in Coveo. We will be in touch with you shortly.
API Technical Writer
- Montreal / Quebec City (Province of Quebec, Canada)
- Research and Development
- Full-time
- Hybrid
< See All Positions
The expert behind clear, accurate, and user-friendly developer documentation.
API writers are responsible for most of Coveo's public-facing developer documentation. In other words, they are responsible for reviewing all API and library reference documentation, in addition to writing guides, examples, tutorials, etc.
The team also maintains the documentation site and automates as much of the documentation generation as possible, which entails a significant amount of coding.
Here is a glimpse at your responsibilities:
- Integrate seamlessly into the agile workflow of project teams, collaborating with developers and product managers to ensure documentation stays in sync with development cycles.
- Gain in-depth understanding of new components and features, providing feedback and suggesting improvements to make these products more effective and easier to use.
- Create generalized, reusable code samples from real-world project code, ensuring they are clean, well-commented, and easy for users to adapt to their own needs.
- Set up scripts and automated deployments to seamlessly generate reference documentation from code annotations whenever a new version of an API or library is released.
- Update and manage the documentation site by pulling, committing, and pushing content and container changes, ensuring the most current version of the documentation is always available and that the documentation experience is world-class.
Here is what will qualify you for the role :
- Strong technical understanding of APIs and front-end development.
- Strong writing and communication skills.
- Strong experience with documentation tools and automation.
What would make you stand out :
- Experience generating reference documentation: use scripts to turn code annotations into clear, detailed and user friendly developer docs.
- Familiarity with Ruby, GitHub actions and front-end frameworks such as React and Next.js.
Do you think you can bring this role to life? Send us your application and join the Coveolife!
We encourage all qualified candidates to apply regardless of, for example, age, gender, disability, gaps in CV, national or ethnic background. We know that applying for a new role is a lot of work and we really appreciate your time.
Absolutely! This is a question women and under-represented groups ask themselves more often than the rest of the population. Don't underestimate yourself, we are not looking for someone perfect but for someone who is motivated, capable and who will thrive in this position. Allow us to discover you!
Coveo is a Quebec-based company, pioneer in AI-powered search and recommendations. Coveo uses AI technologies and intelligent search to personalize every digital experience for customers, partners, dealers, and employees. Coveo combines unified content, unified interactions behavioral data and machine learning to deliver relevant information and recommendations across every business interaction, making websites, e-commerce, contact centers and intranets efficient, effortless, content-rich, thus boosting conversion.
If it were easy, someone else would have done it. All of our colleagues at Coveo find the drive to continuously seek new challenges and test roads no one else has ever explored. This ethos has allowed us to become a world leader in an innovative industry and to create a collaborative, diverse and trusting place to work filled with amazingly talented and passionate people. We love a good challenge, and we never say no to an opportunity to learn and develop new cutting-edge skills. Discover our values here
In-person
This role requires you to be in the office full-time, whether it be at our Quebec, Montreal, Weert, or London locations. Our modern infrastructures are designed to enhance cross-team collaboration and promote overall well-being.
Hybrid
Our offices in Quebec City, Montreal, London and Weert are designed to foster collaboration and your well-being. We gather there on our pillar days two times a week to strengthen in-person interactions and encourage creativity, all while providing you with the flexibility of a hybrid environment.
Remote
We hire from all over the world because the diversity of backgrounds fuels our continuous innovation. Our benefits will enable you to work comfortably from home, but you may be required to travel to attend our in-person team-building events.
