Senior API Technical Writer

Compu- Vision Consulting, Inc.

Job Description

Title: Senior API Technical Writer
Location: IL (Remote)
Duration: 3 Months
Positions Needed: 1
Employment Type: Temporary - 3 Month Contract, Part Time Roughly 20 Hours a Week

We are looking for an experienced Senior Technical Writer for a 3 Months Contract Part time role with one of our client. This is a full time remote role.

Key Responsibilities:

  • Creation of Developer Portal Documentation Strategy: defining key content elements needed for the developer portal, a content governance strategy plan, and tagging strategy.
  • Creation of Technical Documentation: How-To's, developer guides, SDK's documentation, quick start manuals, FAQs, non-reference materials that provide introductory help with task-based steps of integration.
  • Creation of API Documentation templates and writing guides.
  • Creation of Marketing Content.

Job Requirements


  • We are looking for an experienced technical writer with extensive experience building or maintaining API Developer Portals.
  • Experience with Azure API Management.
  • Experience with REST documentation. (SOAP experience helpful, but not required)
  • Be able to read code and ask software engineers informed questions.

Technical Abilities:

  • CSS, HTML, JSON, GitHub, Swagger, Postman, Markdown.
  • Experience with document driven development.