API Writer

  • Quebec, Canada
  • Research and Development
  • Full-time
See All Positions

For a next-level documentation platform .

What can be better than to use state-of-the-art open-source tools to work on documentation for developers? To work at building THE best documentation for developers, of course! As many other software companies, Coveo makes its documentation available for all. BUT! for this project (as for all of our other features), we want to raise the bar on what is currently available out there.

Which is why we are currently looking for an experienced API Writer to join our team. At Coveo, API writers are responsible for Coveo’s documentation for developers. This means they notably review all API references documents, while also writing guides, tutorials, etc. They also develop and maintain the documentation and learning platform websites. (Curious? Have a look:  https://docs.coveo.com & https://levelup.coveo.com). 

Here’s an overview of some typical projects?  

  • Write a module oriented toward helping developers adopt one of our new libraries.
  • Review API references documentation written by R&D developers for the new REST service
  • Attend a lunch & learn session with the documentation team to discuss interesting tools and information architecture (ex: What about trying to build a PoC to migrate our documentation into a new system?)
  • Write a script to automate the extraction and publication of a library’s reference documentation from annotations in the source code 
  • Write a public release note about a new version of a library
  • Produce an example of functional code to demonstrate a use case for one of our libraries.

Seems like something you would do?

We are looking for someone who is used to writing documentation for developers and that can hold his/her own in programming as well. You must be capable of putting yourself in a developer’s shoes, and create documentation that will be well adapted to this target audience.Besides writing documentation, guides or code examples, we want our new recruit to be able to bring new ideas to improve the developer's experience while consulting our documentation. Because, for developers to love using our products, we must first ensure they like using our documentation, and give them all the information they need to leverage all our features!

Some technical skills useful for the role: 

- Extensive Knowledge of HTML, CSS, SASS, JavaScript and TypeScript, and also some popular web frameworks (ex: React, Vue, Angular).

- A general understanding of Source code control (ex.: Git, Mercurial) and hosting  (ex.: GitHub, BitBucket) systems

- Knowledge of best practices and recent school of thoughts for technical documentation (ex: docs as code, reusing content).

- Knowledge of common markup languages (ex.: Markdown, AsciiDoc) and of API REST descriptions (ex.: Open API, RAML)

- Some experience with one or many tools often used to generate reference documentation (ex.: Redoc, TypeDoc) and static sites (ex.: Antora, Hugo, Jekyll).

Some important soft-skills for the role:

  • A desire to go beyond what is actually made to challenge the status quo and try new stuff
    A great capacity to synthesize and structure information
  • A great capacity to communicate that information to match!
  • A great curiosity for technologies and their usage

 

Seems like a challenge tailored for you? Don’t wait any longer and apply now. We would love to have a chat with you!. 

Join the Coveolife!

What is Coveo?

Coveo makes business personal. Coveo uses AI technologies and intelligent search to personalize every digital experience for customers, partners, dealers, and employees. Coveo combines unified content, unified interactions behavioural data and machine learning to deliver relevant information and recommendations across every business interaction, making websites, e-commerce, contact centres and intranets efficient, effortless, content-rich, thus boosting conversion. Coveo is also embedded in many leading business applications from vendors including Microsoft Dynamics, Salesforce, ServiceNow, Sitecore, Xero and more.

What is it like to work at Coveo?

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. This is also why Coveo was named Employer of the year AND Company of the year 2019 by the Quebec Chamber of Commerce!

Apply for this job

Resume*
Resume*
Browse or drop your resume here Browse, drop or paste your resume here
Close
Cover Letter
Cover Letter
Browse or drop your cover letter here Browse, drop or paste your cover letter here
Close
Which office is the closest to you? *
Are you legally authorized to work in Canada? *
For more information regarding how we use your personal information as part of the recruitment process, please read our Candidate Privacy Policy available here: https://www.coveo.com/en/pages/applicant-and-candidate-privacy-notice.*
We're sorry, we have not been able to submit your application. Please try again. If the problem persists, please send us a message at <a href="mailto:hr@coveo.com">hr@coveo.com</a>.