Trending Jobs

API Technical Writer


A software development company is looking for a talented and detail-oriented API Technical Writer to join their growing team.

The company creating the world’s most used route sequencing and optimization software for small businesses and enterprises. With over 35,000 customers, the company helps last mile businesses save tremendous amounts of money, time, and labor. Moreover, provides seamless continuity through the entire route planning, route dispatch, route navigation, and tracking process. 

The company offers exposure to a variety of industries and technologies, room to grow as a professional, time in projects to learn new skills and an opportunity to work with phenomenal coworkers, some of the best people on the planet.

As an API Technical Writer, you will play a crucial role in creating clear, concise, and comprehensive Technical Documentation. Your documentation will be essential in assisting developers, partners, and customers in effectively understanding, integrating, and utilizing API.

The first and most important project is to analyze and improve our existing API documentation. After that, there will be opportunities to continue our collaboration as a Technical Writer on other projects.

As an API Technical Writer you will:

  • Create and maintain high-quality API documentation, including reference guides, developer guides, tutorials, sample code examples, and similar documentation.
  • Improve existing API documentation and ensure that it adheres to the company’s style guidelines, is user-friendly, and follows industry best practices (examples will be provided).
  • Collaborate with development teams to gather technical information and specifications needed for accurate API documentation.
  • Keep the API documentation up-to-date with the latest API releases, changes, and improvements.
  • Contribute to API release notes, communicating changes, enhancements, and bug fixes to developers and stakeholders.

Requirements:

  • Proven experience of 5+ years as a Technical Writer, with a focus on API documentation.
  • Proven experience using such tools as Jira, Confluence, Swagger, OpenAPI, Postman, ReadMe, Lucidchart, Google Workspace tools, and similar.
  • Strong understanding of APIs, RESTful web services, and programming concepts with respective proven experience.
  • Experience creating training manuals, instructional materials, video tutorials, and other types of learning content.
  • Proficiency in writing clear, concise, and well-structured technical documentation.
  • Attention to detail and a commitment to delivering accurate and user-friendly documentation.
  • Excellent communication and collaboration skills, with the ability to work effectively with cross-functional teams.

Nice to have:

  • Experience with markup languages (e.i., Markdown), version control systems (e.i., Git), and documentation formatting tools.
  • Experience in software development or exposure to coding languages (e.i., Python, PHP, etc.).

Benefits:

  • Semi-flexible working hours;
  • Completely remote work;
  • Interesting projects to work on;
  • Exposure to a variety of industries and technologies;
  • Paid vacations and sick leaves.

#Li – remote



Source link

Related Articles

Leave a Reply

Your email address will not be published. Required fields are marked *

Back to top button