API Writer

  • Montréal / Québec City (Quebec Province)
  • 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!

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.

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? *
Is there a preferred pronoun we should use? / Y a-t-il un pronom spécifique que nous devrions utiliser? (optional/optionnel)
Are you currently legally allowed to work in Canada? / Es-tu présentement légalement autorisé.e à travailler au Canada?*
How many years of experience relevant to this role do you estimate you have? Combien d'années d'expérience pertinente pour le rôle estimes-tu avoir ?*
How did you hear about Coveo? / Comment as-tu entendu parler de Coveo?*
For more information regarding how we use your personal information as part of the recruitment process, please read our Candidate Privacy Policy available: https://www.coveo.com/en/pages/applicant-and-candidate-privacy-notice / Pour obtenir plus d'information concernant l'utilisation de vos données personnelles lors du processus de recrutement, veuillez consulter notre Déclaration de protection de la vie privée : https://www.coveo.com/fr/pages/declaration-de-protection-de-la-vie-privee-des-candidats*
Have you ever been convicted of a criminal offense related to the coveted job for which you have not obtained pardon, been expunged or had your record sealed? / As-tu déjà été reconnu.e coupable d'une infraction criminelle en lien avec la nature de l’emploi convoité et pour laquelle tu n'as pas obtenu pardon?*
U.S. Equal Opportunity Employment Information (Completion is voluntary)

Individuals seeking employment at this company are considered without regards to race, color, religion, national origin, age, sex, marital status, ancestry, physical or mental disability, veteran status, gender identity, or sexual orientation. You are being given the opportunity to provide the following information in order to help us comply with federal and state Equal Employment Opportunity/Affirmative Action record keeping, reporting, and other legal requirements.

Completion of the form is entirely voluntary. Whatever your decision, it will not be considered in the hiring process or thereafter. Any information that you do provide will be recorded and maintained in a confidential file.

Gender
Race

Race & Ethnicity Definitions

If you believe you belong to any of the categories of protected veterans listed below, please indicate by making the appropriate selection. As a government contractor subject to Vietnam Era Veterans Readjustment Assistance Act (VEVRAA), we request this information in order to measure the effectiveness of the outreach and positive recruitment efforts we undertake pursuant to VEVRAA. Classification of protected categories is as follows:

A "disabled veteran" is one of the following: a veteran of the U.S. military, ground, naval or air service who is entitled to compensation (or who but for the receipt of military retired pay would be entitled to compensation) under laws administered by the Secretary of Veterans Affairs; or a person who was discharged or released from active duty because of a service-connected disability.

A "recently separated veteran" means any veteran during the three-year period beginning on the date of such veteran's discharge or release from active duty in the U.S. military, ground, naval, or air service.

An "active duty wartime or campaign badge veteran" means a veteran who served on active duty in the U.S. military, ground, naval or air service during a war, or in a campaign or expedition for which a campaign badge has been authorized under the laws administered by the Department of Defense.

An "Armed forces service medal veteran" means a veteran who, while serving on active duty in the U.S. military, ground, naval or air service, participated in a United States military operation for which an Armed Forces service medal was awarded pursuant to Executive Order 12985.

Veteran Status

Form CC-305

OMB Control Number 1250-0005

Expires 05/31/2023

Voluntary Self-Identification of Disability

Why are you being asked to complete this form?

We are a federal contractor or subcontractor required by law to provide equal employment opportunity to qualified people with disabilities. We are also required to measure our progress toward having at least 7% of our workforce be individuals with disabilities. To do this, we must ask applicants and employees if they have a disability or have ever had a disability. Because a person may become disabled at any time, we ask all of our employees to update their information at least every five years.

Identifying yourself as an individual with a disability is voluntary, and we hope that you will choose to do so. Your answer will be maintained confidentially and not be seen by selecting officials or anyone else involved in making personnel decisions. Completing the form will not negatively impact you in any way, regardless of whether you have self-identified in the past. For more information about this form or the equal employment obligations of federal contractors under Section 503 of the Rehabilitation Act, visit the U.S. Department of Labor’s Office of Federal Contract Compliance Programs (OFCCP) website at www.dol.gov/ofccp.

How do you know if you have a disability?

You are considered to have a disability if you have a physical or mental impairment or medical condition that substantially limits a major life activity, or if you have a history or record of such an impairment or medical condition.

Disabilities include, but are not limited to:

  • Autism
  • Autoimmune disorder, for example, lupus, fibromyalgia, rheumatoid arthritis, or HIV/AIDS
  • Blind or low vision
  • Cancer
  • Cardiovascular or heart disease
  • Celiac disease
  • Cerebral palsy
  • Deaf or hard of hearing
  • Depression or anxiety
  • Diabetes
  • Epilepsy
  • Gastrointestinal disorders, for example, Crohn's Disease, or irritable bowel syndrome
  • Intellectual disability
  • Missing limbs or partially missing limbs
  • Nervous system condition for example, migraine headaches, Parkinson’s disease, or Multiple sclerosis (MS)
  • Psychiatric condition, for example, bipolar disorder, schizophrenia, PTSD, or major depression
Disability Status

1Section 503 of the Rehabilitation Act of 1973, as amended. For more information about this form or the equal employment obligations of Federal contractors, visit the U.S. Department of Labor's Office of Federal Contract Compliance Programs (OFCCP) website at www.dol.gov/ofccp.

PUBLIC BURDEN STATEMENT: According to the Paperwork Reduction Act of 1995 no persons are required to respond to a collection of information unless such collection displays a valid OMB control number. This survey should take about 5 minutes to complete.

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 hr@coveo.com.
drift close

Hey 👋! What has you exploring Coveo today?

drift bot
1