Technical Writer - API Documentation

Job Description

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.
• Review documents written by developers / PMs for a particular API and suggest changes / seek clarity to externalize the same documents.
• Supplement developer documentation with relevant sample code to reduce grounds-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 Open API’s.
• Be the first to respond to developer queries on API forums and put effort to resolve the issue yourself, without needing to check with the core development organization.
• Use your extensive knowledge of the needs of developers and pass this feedback internally to develop the next set of Open API’s.

Qualifications

• Bachelor degree in computer science, technical writing, core sciences or equivalent experience.
• Minimum of 6+ years’ experience in technical documentation, and / or developer outreach / technology partner management roles.
• Knowledge of tools such as Jekyll, Wordpress, Adobe Framemaker, Oxygen XML author, Lucid Chart, Visio is a must.
• Experience using Git to manage asynchronous collaboration across large teams
• Experience with authoring documentation in Markdown is core.
• 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 data analytics and big data technologies is a plus.
• Demonstrate experience in writing and proofreading of content, especially technology related content.
• Great communication skills and ability to work well with others.
• 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.

Qualifications

Bachelor Degree

Additional Information

All your information will be kept confidential according to EEO guidelines.