Technical Writer

Marshwinds International  •  Denver, CO
Salary depends on experience
Posted on 06/08/18 by Parth Panchal
Marshwinds International
Denver, CO
Technology
Salary depends on experience
Posted on 06/08/18 Parth Panchal

Location: Denver, CO

Role: Technical Writer

 

Technical Writer Job Description

Description

We are looking for a proactive technical writer to identify, document and diagram our current React architecture and orchestration API infrastructure and stack and develop training materials for developers and product owners to be able to onboard onto a new software architecture and stack. This role will also be responsible for working closely with developers to understand and document proposals and new ideas for review and endorsement by the technical steering committee.

Roles and Responsibilities

  • Work with front end and back end developers to understand architecture and technical concepts
  • Create technical documentation in GitHub and Confluence for developers and product owners to come up to speed and onboard onto a new React and REST API stack
  • Develop training materials and slides on the React application architecture and orchestration API?s
  • Create architectural diagrams of the application architecture
  • Create build pipeline and branching strategy diagrams
  • Document best practices and white papers for our software
  • Document new concepts and proposals for review by developers and the technical steering committee
  • Clean up existing documentation

Skills

  • Ability to create simple and clear documentation around complex technical concepts and ideas
  • Self-motivated to seek out gaps in documentation and training materials and fill in those gaps
  • Ability to work with developers and product managers to understand technical ideas and translate them into understandable documentation for developers new to the concepts
  • Markdown language and creating documentation in GitHub as well as Gitbooks
  • Ability to do basic GitHub pull requests to update documentation in GitHub
  • Ability to create documentation in Atlassian Confluence
  • Ability to work with JIRA stories and translate them into documentation as necessary
  • Experience documenting React applications and React architectural concepts

Experience documenting REST API?s and API architecture

Not the right job?
Join Ladders to find it.
With a free Ladders account, you can find the best jobs for you and be found by over 20,0000 recruiters.