Develop comprehensive documentation of our APIs for our partner firms.
Focus on creating top notch developer experience for partners.
Obtain a deep understanding of our products to translate complex product information into simple, polished, and engaging content.
Evaluate current content and develop innovative approaches for improvement.
Research, outline, write, and edit new and existing content, working closely with various departments to understand documentation requirements.
Independently gather information from subject matter experts to develop, organize, and write FAQs, Playbooks etc
Work with development and support leads to identify all documentation repositories, revise and edit, and determine the best solution for data compilation and centralized storage.
Research, create, and maintain information architecture templates that uphold organizational and legal standards, and allow for easy data migration.
Good understanding of CMS tools for handling documentation.
Folks who have done API documentation before. Also have used a Documentation CMS before and understand formatting of technical docs well
Have 3-5 years of experience.
Have the ability to grasp technical concepts and translate them into clear docs and Help Centre articles
Extremely good written and verbal communication skills (Needed since they are writing documents for external users. Also needed because they’ll need to coordinate with multiple internal teams)
Engineering educational background is preferred (not mandatory)
Good to Have
Prior industry experience as an effective technical writer for APIs in a software and technology company.
Proven ability to quickly learn and understand complex technical topics.
Previous experience writing documentation and procedural materials for multiple audiences.
Superior written and verbal communication skills, with a keen eye for detail.
Ability to coordinate with multiple internal and external stakeholders to create best in class documentation for our products