Developer Writer

Job Description

The expert behind a clear, accurate, and user-friendly documentation experience.

Developer writers are in charge of Coveo's documentation site, automating documentation generation, and producing documentation tooling for other Coveo documentarians.

The team is also responsible for most of Coveo's public-facing developer documentation. This includes reviewing all API and library reference documentation, in addition to writing guides, examples, tutorials, etc. The work ratio is approximately 80% coding and 20% writing.

What makes this opportunity exciting?

Because documentation developers work closely with product managers and development teams, and because they have a wide view of how different Coveo APIs and libraries connect together, they can provide highly valuable input during product development. In other words, the role isn't limited to crafting a great documentation experience, it's about crafting a great developer experience in general.

Here is a glimpse at your responsibilities:

• 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.
• 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.

Here is what will qualify you for the role:

• Strong technical understanding of APIs and front-end development.
• Strong writing and communication skills.

Here is what would make you stand out:

• Experience with documentation tools and automation.
• 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?

You don't need to check every single box; passion goes a long way and we appreciate that skillsets are transferable.

Send us your application, we want to get to know you!

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.

li-hybrid