Upwork is hiring a Technical Writer (API Documentation)

Job brief

We are looking for a Technical Writer to produce high-quality API documentation that contributes to the

overall success of our products. You will work collaboratively with developers, quality engineers,

product managers, and usability experts to make our products easier to use.

Responsibilities

 Write API documentation for API users, such as API reference docs and developer guides. Keep

emphasis on documentation that is technically accurate and brings clarity for even complex

processes.

 Work with the Product and Platform teams for documenting the API’s seek clarity to externalize

the same documents.

 Supplement developer documentation with relevant sample code to reduce ground-up efforts

of external developers.

 Develop and use all types of content types (workflows / process schematics / instructional

videos / developer consoles) to simplify the user’s understanding of the Platform API’s.

 Produce high-quality documentation that meets applicable Open API Specifications standards

and is appropriate for its intended audience.

 Write easy-to-understand user interface text, online help, and developer guides.

 Create tutorials to help end-users use a variety of applications.

 Analyze existing and potential content, focusing on reuse and single-sourcing opportunities.

 Create and maintain the information architecture.

Requirements and skills

 Familiarity with API documentation tools such as Swagger

 Knowledge of REST APIs is a must.

 Experience with programming to enable sample code will require experience, especially around

core web technologies such as Python / JavaScript / JSON / HTML required. Knowledge of

Information Security, Cyber Security, Banking/Fintech Domain is a plus.

 Demonstrate experience in writing and proofreading of content, especially technology related

content.

 Proven working experience in technical writing of software documentation.

 Ability to deliver high quality documentation paying attention to detail.

 Ability to quickly grasp complex technical concepts and make them easily understandable in text

and pictures.

 Ability to organize and create multimedia content to explain use cases and process flows.

 Ability to handle stressful, time critical projects and deliver great user outcomes.