Senior Technical Writer (API)
CNX•USA, GA, Work-at-Home, GA
•$92,250 - $105,000•Remote
About The Position
We are seeking a Technical Writer to join our remote team in the USA and help shape clear, accurate, and scalable documentation for emerging technical services. In this role, you will enhance Swagger documentation, create comprehensive API and service documentation, and develop visual artifacts that make complex, multi-system solutions easier to understand. This position plays an important role in supporting migration efforts, partner enablement, and customer onboarding by transforming technical details into documentation that is accessible, actionable, and trusted.
Requirements
- 5+ years of proven experience in technical writing or technical documentation, preferably within software development, API, or developer-focused environments.
- Hands-on experience creating, editing, and maintaining Swagger/OpenAPI documentation.
- Strong ability to understand technical concepts and translate them into clear, user-focused documentation for varied audiences.
- Experience developing sequence diagrams, high-level designs, system flows, or similar technical documentation assets.
- Excellent written and verbal communication skills, with the ability to clarify technical information through collaboration with subject matter experts.
- Strong organizational skills with the ability to manage multiple projects, meet deadlines, and adapt as priorities evolve.
- Detail-oriented approach with a commitment to documentation accuracy, usability, and consistency.
- Comfortable working remotely and collaborating across distributed teams.
Nice To Haves
- Prior experience supporting partner onboarding, customer enablement, or technical inquiries is preferred.
Responsibilities
- Enhance and refine existing Swagger documentation for the API catalog, ensuring accuracy, consistency, and usability.
- Create comprehensive technical documentation for new and emerging services, including API references, implementation guidance, process flows, and supporting materials.
- Develop sequence diagrams, high-level designs, and other technical visuals to explain complex, multi-system service interactions.
- Partner with developers, architects, product teams, and technical stakeholders to gather information and translate it into clear documentation.
- Support technical inquiries from partners, prospects, and internal teams to help enable smooth partner and customer onboarding.
- Document new APIs and services as they launch, ensuring materials are available, accurate, and aligned with evolving capabilities.
- Continuously review, update, and improve documentation as service features, technical requirements, and user needs change.
- Manage multiple documentation priorities in a fast-paced environment while maintaining strong attention to detail and quality.
- Help establish documentation practices that improve clarity, consistency, and scalability across technical content.
Benefits
- medical, dental, and vision insurance
- comprehensive employee assistance program
- 401(k) retirement plan
- paid time off and holidays
Stand Out From the Crowd
Upload your resume and get instant feedback on how well it matches this job.
Upload and Match Resume
What This Job Offers
Job Type
Full-time
Career Level
Senior
Education Level
No Education Listed
