Technical Writer - API Documentation

Dreamztech; Sunnyvale (CA); On-site; USD 80,000 - 100,000; Full time

Job summary

Dreamztech in Sunnyvale, California is looking for an experienced API Documentation Specialist. Your role will involve writing clear documentation that enhances developers' understanding of APIs and providing sample codes. You will also collaborate closely with various teams to improve the overall API user experience.

The ideal candidate has over 6 years of experience in technical writing, a bachelor’s degree in a related field, and proficiency in tools like Git and Swagger. This position offers a chance to greatly impact developer productivity.

Qualifications

• 6+ years of experience in technical documentation or related fields.
• Ability to work with developers to enhance documentation.
• Experience in multimedia content creation.

Responsibilities

• Write and review API documentation for clarity and accuracy.
• Respond to developer queries on API forums.
• Organize and create multimedia content.

Skills

Technical documentation

API knowledge

Communication skills

Education

Bachelor degree in computer science or equivalent

Tools

Swagger

Git

Markdown

Jekyll

Wordpress

Adobe Framemaker

Lucid Chart

Visio

Job description

As the first consumer of newer capabilities of our API platforms, you will be required to not only document these API’s, but also critically assess their functionality on offer and recommend changes that will help make the end developer’s life easier and more productive. You will also have the opportunity to develop code occasionally and expect candidates to have a sufficient comfort level with source code to satisfy the API consumer’s needs.

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

Additional Information

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