DreamzTech Solutions

DreamzTech Solutions

Technical Writer - API Documentation

Sunnyvale, CA, United States

Sponsorship not specifiedDetected 3309 days ago
JavaScriptPythonHTMLGitRESTOpenAPIData AnalysisWordPressCommunicationCollaborationWriting

About the role

  • Job Description Responsibilities - Write API documentation for API users, such as API reference docs and developer guides.

Responsibilities

  • Review documents written by developers / PMs for a particular API and suggest changes / seek clarity to externalize the same documents.
  • 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.
  • Use your extensive knowledge of the needs of developers and pass this feedback internally to develop the next set of Open API's.
  • Minimum of 6+ years' experience in technical documentation, and / or developer outreach / technology partner management roles.
  • Experience using Git to manage asynchronous collaboration across large teams
  • 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.

Requirements

  • Bachelor degree in computer science, technical writing, core sciences or equivalent experience.
  • Knowledge of tools such as Jekyll, Wordpress, Adobe Framemaker, Oxygen XML author, Lucid Chart, Visio is a must.
  • 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.

Nice to have

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

Equal opportunity

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

This listing is sourced directly from DreamzTech Solutions's careers page and normalized into a canonical job model.