Api Technical Writer

1 day ago


Montréal QC HB S, Canada Coveo Full time

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


  • Technical Writer

    2 months ago


    Montréal, QC, Canada Maya HTT Full time

    MAYA HTT is a world leading developer of digital industries software solutions. The world’s top tier engineering and manufacturing organizations rely on MAYA’s experience and expertise to achieve the full potential of their software investment. MAYA HTT is at the forefront of innovation technology. Our team delivers extensive engineering and CAE...

  • Technical Writer

    5 months ago


    Montréal, Canada Octasic Full time

    Founded in 1998, Octasic is a leading worldwide provider of systems and complete solutions in advanced communication. We provide SoCs, software, and integrated hardware/software platforms for the worldwide mobile wireless and media processing markets. **We choose Octasic for**: - A workplace at the cutting edge of technology and to be in contact with...

  • Technical Writer

    5 months ago


    Montréal, Canada ARxIUM Full time

    ARxIUM is a leader in the development of advanced pharmacy technology and solutions. Here you have the opportunity to work with the best experts in the pharmacy health systems sector paving the way with innovative automation hardware and software technologies. ARxIUM has been providing innovative solutions in the pharmacy automation space for over twenty...

  • Technical Writer

    6 months ago


    Montréal, Canada mackinnonandpartner Full time

    **Position: Technical Writer** **A hybrid work environment with a requirement to be on-site at least two days per week.** **The standard workweek of 37.5 hours.** **Immediate start with a contract duration of six months.** **French required** **Requirements, Qualifications**: - Proven experience as a technical writer in a technology-driven...

  • Technical Writer

    5 months ago


    Montréal, Canada Aylo Careers Full time

    We are looking for a **Technical Writer** to work one of their the data engineering team. Work with Product owners and Engineers to create internal and external documentation of our Data lake infrastructure, our PAAS/SAAS solutions. **What you will be doing**: - Complete writing assignments and documentation according to standards set by the Technical...

  • Technical Writer

    5 months ago


    Montréal, Canada PROCECO Full time

    For five decades, PROCECO Ltd. has specialized in the design and manufacture of industrial parts washers and custom integrated systems for precision cleaning, high-pressure water-jet deburring, fluorescent penetrant inspection, surface treatment, and wastewater treatment. We're seeking a skilled Technical Writer to join our dynamic team and play a pivotal...

  • Technical Writer

    6 months ago


    Montréal, Canada BrainBox AI Inc. Full time

    **BrainBox AI** utilizes self-adapted artificial intelligence technology to proactively optimize the energy consumption of one of the largest climate change contributors: Buildings. Our AI engine supports a self-operating building that requires no human intervention. Using deep learning, cloud-based computing, and our proprietary process, our solution...

  • Lead Technical Writer

    2 weeks ago


    Montréal, QC, Canada Cisco Systems Full time

    Isovalent, now part of Cisco, is the company founded by the creators of Cilium and eBPF. Cisco Isovalent builds open-source software and enterprise solutions solving networking, security, and observability needs for modern cloud native infrastructure. The flagship technology, Cilium, is the choice of numerous, industry-leading, global organizations. **About...

  • Proposal Writer

    3 months ago


    Montréal, QC, Canada Evolving Web Full time

    Do you want to work at a dynamic digital agency and help translate client needs into meaningful proposals? As a Proposal Writer, you’ll collaborate with a team that drives the growth of our client base and builds long-term relationships with existing customers. You’ll work with our sales team, as well as technical and creative teams to turn ideas into...


  • Montréal, QC, Canada Lightspeed Full time

    Hi there! Thanks for stopping by Are you actively looking for a new opportunity? Or just checking the market? Wellyou might just be in the right place! The Technical Partner Manager, Golf (Solutions Engineer) is responsible for the technical engineering of new partner integrations for our Golf and eCommerce products. Each partner has an individual...

  • Proposal Writer

    2 months ago


    Montréal, QC, Canada Olameter Corporation Full time

    **Olameter is hiring a Proposal Writer**! The Proposal Writer is a key player driving new business opportunities by creating high-quality proposals, presentations, and marketing materials within company guidelines, all in a fast-paced, deadline-driven environment. This position will work diligently in a collaborative environment, across all internal...


  • Montréal, QC, Canada Pharmascience Inc. Full time

    As the Specialist, Production Technical Support, you will be responsible to identify and evaluate the manufacturing processes of products already marketed (Internal and/or external) to improve their quality, costs and/or efficiency. You will evaluate new sources of raw materials and/or excipients and make recommendations. You will perform the various tasks...

  • Api Specialist, Golf

    2 weeks ago


    Montréal, QC, Canada Lightspeed Full time

    Hi there! Thanks for stopping by Are you actively looking for a new opportunity? Or just checking the market? Wellyou might just be in the right place! The API Specialist is responsible for the technical engineering of new partner integrations for our Golf and eCommerce products. Each partner has an individual Go-To-Market program that aligns with the...

  • Technical Writer

    5 months ago


    Montréal, Canada Ubisoft Full time

    As a UX Writer at Ubi MTL, you’ll come up with the words that help players understand what things are and what they need to do in a live game. You’ll write user interface copy to intuitively describe and explain, in and around gameplay: instructions, menus, buttons, and more. As an online gamer yourself, you know that when it comes to communicating,...

  • Technical Writer

    5 months ago


    Montréal, Canada Booxi Full time

    Booxi is a scale-up that makes millions of appointments possible each year to enhance brand customer experiences, engage their clients, and ultimately make commerce more human while improving conversion rates, average basket size, and customer loyalty. Our SaaS solution is dedicated to the retail industry, specifically catering to major accounts such as...

  • Technical Writer

    6 months ago


    Montréal, Canada Booxi Full time

    Booxi is a scale-up that makes millions of appointments possible each year to enhance brand customer experiences, engage their clients, and ultimately make commerce more human while improving conversion rates, average basket size, and customer loyalty. Our SaaS solution is dedicated to the retail industry, specifically catering to major accounts such as...

  • Team Lead, Api

    6 months ago


    Montréal, Canada Genetec Full time

    ** Covered Territories: Vancouver (BC), Edmonton (AB), Winnipeg (MB), Fredericton (NB), Halifax (NS) ** **The team**: We are looking for a talented Senior Power Platform Developer with a strong focus on API integration to lead the development and deployment of Power Platform solutions that streamline our operations, automate workflows, and integrate...


  • Montréal, QC, Canada Unity Technologies Full time

    **L'opportunité** Nous pensons chez Unity que le monde se porte mieux avec plus de créateur(rice)s. Rejoignez l'équipe Docs pour contribuer à leur réussite! Dans ce rôle, vous acquerrez une connaissance technique approfondie des produits Unity, en travaillant en étroite collaboration avec les équipes de développement et les technologies...


  • Montréal, Canada Communica, a WSP Company Full time

    **About Communica, a WSP company** Communica, a WSP company is one of Canada’s largest Indigenous and stakeholder regulatory engagement consulting firms. Headquartered in Calgary, our services concentrate on four core pillars of expertise: Indigenous engagement, stakeholder engagement, communications and Stakeholder Information Management. Our work is...

  • Proposal Writer

    2 months ago


    Montréal, QC, Canada Pomerleau Full time

    **_Ready to build your career? We want to hear from you._** As a proposal writer, you'll use your writing skills to highlight the company's experience, its people and the technical information needed to develop high-quality proposals that meet tender requirements. With an eye for detail and a creative mind, you will collaborate with team members and ensure...