Technical Writer – Developer Focused
Compose.ly
contract
Posted on:
Location Type: Remote
Location: New York • United States
Visit company websiteExplore more
Salary
💰 $45 - $55 per hour
About the role
- Plan and write documentation for developers, ML engineers, and technical architects of all experience levels: Technical guides, API and client references, walkthroughs, and sample apps.
- Contribute to the information architecture and user experience of the developer portal.
- Create a maintenance and iterative improvement cycle for our documentation
- Collaborate closely with engineering and product on new feature documentation.
- Collaborate closely with customer success and developer advocates to understand user needs and address them with documentation.
- Collect and use qualitative (eg, user research) and quantitative (eg, analytics) data to help improve the documentation content and user experience.
Requirements
- Experience planning, researching, writing, and editing technical documentation for developers in a startup environment.
- Experience using and documenting SDKs, APIs, and similar tools.
- Proficiency with static site generators, version control, managing docs as code, OpenAPI, and a docs platform such as Redocly or Readme.
- Superb writing skills with an obsession for clarity, accuracy, and simplicity.
- Curiosity, thoroughness, organization, enthusiasm, and self-direction.
- Preferred but not required: Experience with databases, machine learning, or search technologies.
- Experience creating diagrams and video tutorials.
Applicant Tracking System Keywords
Tip: use these terms in your resume and cover letter to boost ATS matches.
Hard Skills & Tools
technical documentationSDKsAPIsstatic site generatorsversion controlOpenAPIRedoclyReadmediagramsvideo tutorials
Soft Skills
writing skillsclarityaccuracysimplicitycuriositythoroughnessorganizationenthusiasmself-direction