Technical Writer - Remote

  • Infinity Consulting Solutions
  • Remote * (Illinois, USA)
  • Apr 08, 2021
Journalism Telecommuting Writing

Job Description

Job Description - Technical Writer - Remote

TECHNICAL WRITER

A global professional services firm is seeking an experienced Technical Writer to join their team. The company has recently started a development portal that will launch this Summer and are in need of a Technical Writer that will work with the Product Architecture Team to own the creation of our documentation strategy, writing the documentation, and defining the developer portal documentation standards. The company has an extensive library of API's and properly exposing them to our clients and partners through the right perspective is critical. As a Technical Writer, you will collaborate with senior stakeholders for documentation strategy development, including how the developer portal documentation is structured and organized on the site for ease of consumption by clients and partners, as well as ensuring all critical documentation is developed for the site.

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

Requirements

5+ years doing technical documentation as a Technical Writer

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. - provided by Dice