API Technical Writer

Posted 8 Hours Ago
Be an Early Applicant
2 Locations
Entry level
Software
The Role
The API Technical Writer will create and manage developer documentation, collaborating with project teams to ensure alignment with development cycles. Responsibilities include generating code samples, setting up automation for documentation, and maintaining the documentation site.
Summary Generated by Built In

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.

Top Skills

Ruby
The Company
HQ: Québec
763 Employees
On-site Workplace

What We Do

Coveo powers the digital experiences of the world’s most innovative brands serving millions of people and billions of interactions across every digital experience. After a decade of enriching our market-leading platform with forward-thinking global enterprises, we know what it takes to gain a trusted AI-experience advantage.

We strongly believe that the future is business-to-person, that experience is today’s competitive front line, a make or break for every business.

For enterprises to achieve this AI-experience advantage at scale, it is imperative to have an Enterprise Spinal and composable ability to deliver AI semantic search and generative experiences at each customer and employee interaction.

Similar Jobs

Montréal, QC, CAN
4055 Employees

Ryan Logo Ryan

Technical Writer

Fintech • Consulting
Montréal, QC, CAN
3194 Employees

Unity Logo Unity

Rédacteur(rice) Technique | Technical Writer

Artificial Intelligence • Gaming • Machine Learning • Software • Virtual Reality • Design • Metaverse
Hybrid
Montréal, QC, CAN
5500 Employees

Unity Logo Unity

Rédacteur(rice) Technique | Technical Writer

Artificial Intelligence • Gaming • Machine Learning • Software • Virtual Reality • Design • Metaverse
Hybrid
Montréal, QC, CAN
5500 Employees

Similar Companies Hiring

SailPoint Thumbnail
Software • Security • Sales • Data Privacy • Cybersecurity • Cloud • Artificial Intelligence
Austin, TX
2461 Employees
VTS Thumbnail
Software • Real Estate • PropTech • Productivity • Big Data Analytics
New York City, NY
500 Employees
Citadel Securities Thumbnail
Software • Information Technology • Financial Services
Miami, FL
1900 Employees

Sign up now Access later

Create Free Account

Please log in or sign up to report this job.

Create Free Account