Onward Search has a client that is looking for an API/Technical Writer. This role is responsible both for creating content that allows developers to easily search and navigate the API portal and for documenting our APIs to build upon and update existing developer documentation. You understand the technical writing process, possess the technical expertise to explain complex technical concepts to a technical audience, and have superb communication and collaboration skills.
Responsibilities:
Create exceptional documentation in the form of user guides, integration guides, API developer guides, in-platform instructions, installation/configuration instructions and system operations
Create client resources and educational materials, including demos, tutorials, training materials, guided tours, general & technical overview and FAQs
Research, write, edit and revise content that is both engaging and accessible to user personas with both non-technical and technical backgrounds
Publish release notes to internal and external stakeholders with information on product updates, releases and fixes
Edit developer-written content and documentation for consistency and continuously update content with current information
Maintain tracking and ticketing system to ensure deadlines are met and client deliverables and received on time
Test products for issues, provide insight to resolving problems and ensure documentation is accurate and consistent
Education Requirements:
Bachelor’s degree or the equivalent in experience in English, Communication, Journalism, Software Engineering, Computer Science, Technical Writing, Teaching, Curriculum Development or Scientific Publication
Required Skills:
5+ years experience in technical writing
Strong communications skills, including written, verbal and presentation
Ability to communicate complex technical topics to non-technical stakeholders both internally and externally
Experience writing API specifications using OAS 3.0
Experience using API documentation
Experience using API gateways like Apigee, DataPower, MuleSoft etc.
Experience with CMS such as Drupal or Joomla
Portfolio of technical writing samples
Preferred Skills:
Prior experience working within IT Development, SaaS or web-based technology environment
Experience with Rally, Sketch, InVision, Miro
Experience or exposure to Web Content Accessibility Guidelines (WCAG) accessibility and writing for grade level and other regulatory constraints