Senior Technical Writer (Developer Audience)
Compose.ly · United States · 1 mo ago
RemoteRemoteMarketingFull-time
About the role
This role is for you if you...
Responsibilities
- Work alongside your in-house team and other internal stakeholders to write superior API and SDK documentation that not only informs but engages.
- Prioritize the user and their implementation journey, crafting content that contextualizes technical details in a way that connects to the bigger picture.
- Excel at explaining complex technical information in relatable, straightforward ways that make it easier for developers to dive in and succeed.
- Collaborate closely with product engineering, product management, integration teams, and other internal stakeholders to create user-centric API documentation and programming guides.
- Keep pace with product development teams, using style guidance to produce industry-leading API and programming content that flows logically and tells a cohesive story.
Requirements
- Have proven experience working with software engineering teams and other internal stakeholders to write superior API and SDK documentation that not only informs but engages.
- Communicate and collaborate professionally and efficiently with a geographically distributed team.
- Collaborate closely with product engineering, product management, integration teams, and other internal stakeholders to create user-centric API documentation and programming guides.
- Produce industry-leading API and programming content that flows logically and tells a cohesive story.
- Collaborate closely with product engineering, product management, integration teams, and other internal stakeholders to create user-centric API documentation and programming guides.
Qualifications
- Have a Bachelor's degree or higher (ideally in English, technical communications, computer science, or a similar field)
- Have 3+ years of experience as a technical writer for a developer audience at an Agile software company
- Have proven experience writing detailed, user-centric API and programming documentation in a fast-paced environment
- Have exceptional ability to grasp and communicate interrelationships between topics, presenting information hierarchically in a logical, meaningful, and consistent manner
- Have a user-focused perspective backed by experience and technical accuracy
- Have proficiency in Markdown or another markup language, like HTML, and Swagger
- Have knowledge of one or more programming languages (Java, Go, Python, Typescript) and OpenAPI
- Have the ability to handle and prioritize multiple focus areas and tasks while maintaining a high-velocity and high-quality output
- Have a commitment to adhering to documented standards and styles
- Have enthusiasm for cross-functional collaboration with people at all levels of an organization
- Be able to work in US time zones (ideally Central Standard Time)
- Have a strong writing portfolio demonstrating some or all of these skills
- Have an advanced degree in a related discipline
- Have programming experience
- Have writing with ReadMe