About the Role 

Rocket Lawyer is seeking an experienced, passionate API Technical writer for Rocket Lawyer’s external facing API. In this role, 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. You would be creating accessible, accurate, and developer-friendly documentation that enables external developers to integrate and utilize APIs effectively You will work in an agile, cross-functional team, working with multiple product teams, engineering and program management teams across Rocket Lawyer.

This is a remote freelance role for 2 weeks (80 hours total), accommodating Pacific Standard Time working hours (8AM-5PM PST).

Responsibilities

• Create high-quality API documentation, including reference guides, developer guides, tutorials, and similar documentation and to be published on Apigee Developer Center & Postman 

• Review current documentation, identify gaps, and update as needed

• Improve existing API documentation and ensure that it adheres to the company's style guidelines, is user-friendly, and follows industry best practices 

• Work closely with software engineers, product managers, and other stakeholders to gather the technical information and specifications of the API functionalities and capabilities needed for accurate API documentation

• Collaborate with cross-functional teams including developers, product managers, UX designers, and support teams to ensure consistent and accurate documentation

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, Lucidchart, Apigee, and similar. References to published documentation highly preferred

• 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

Preferred Qualifications: 

• Experience in software development or exposure to coding languages (For example:  Java, Python,  etc.)