Job Description*The final compensation offer will be determined by factors such as the candidate's skills, qualifications, experience, geographic location, and other relevant factors.
Position SummaryContiem is seeking a
Technical Writer with API experience to develop and maintain documentation for our clients. The ideal candidate has worked on a variety of projects, enjoys applying their expertise to new subject areas, and demonstrates strong writing skills. They thrive in fast-paced environments and can confidently work with clients who have varying standards and expectations.
Essential Duties & ResponsibilitiesAPI Documentation Development- Develop, maintain, and publish API documentation for RESTful and GraphQL services.
- Document API endpoints, request and response schemas, authentication methods, error handling, and integration workflows.
- Work directly with engineers and SMEs to gather technical information and validate documentation accuracy.
- Create and maintain API reference guides, developer portals, release notes, and changelogs.
- Produce tested code samples and implementation examples in common programming languages.
Technical Content Creation- Develop user guides, online help systems, installation guides, operational procedures, and maintenance documentation.
- Create step-by-step tutorials, quick start guides, learning paths, and onboarding materials for developers and end users.
- Write project proposals, user test plans, procedural documentation, and technical specifications.
- Edit and improve AI-generated content to ensure technical accuracy, consistency, and usability.
Documentation Quality & Governance- Ensure documentation complies with authoring standards, workflows, and style guidelines.
- Review and update content regularly to reflect product enhancements and system changes.
- Validate API functionality, test endpoints, confirm authentication flows, and verify documentation against actual product behavior.
- Maintain version control and documentation repositories.
Cross-Functional Collaboration- Collaborate with software engineers, product managers, QA teams, project managers, and other stakeholders throughout the documentation lifecycle.
- Coordinate review cycles with SMEs to ensure documentation accuracy and completeness.
- Minimize SME time requirements by researching, drafting, and maintaining documentation.
- Participate in planning sessions, documentation reviews, and product release activities.
Experience and Skills- U.S. citizenship.
- Bachelor's degree in technical writing, journalism, communications, or related field.
- 5-7 years' experience in technical writing, with technical writing being your primary job function.
- Proficient in using the following applications:
- MadCap Flare (or another help authoring tool).
- Microsoft Suite
- Google Workspace
- Adobe Creative Cloud
- DITA XML
- JSON
- Markdown
- HTML 5
- Experience supporting e-commerce, SaaS, developer tools, or technology-focused organizations.
- Experience testing APIs using tools such as Postman or similar API testing platforms.
- Experience reviewing and editing AI-generated technical content.
- Knowledge of DITA XML-based content management and structured authoring methodologies.
- Exposure to software development practices and source code repositories.
Job Benefits- 3 weeks of PTO, 8 paid holidays, 5 additional days for life events such as adoption, childbirth, and marriage.
- Free medical, dental, vision, life insurance and disability coverage.
- 401(k) with 100% match of up to 4% of contributions and with immediate vesting.
- Professional Membership Reimbursement.
- Employee Referral bonus.
Please note, this job description does not cover or contain a comprehensive listing of activities, duties, or responsibilities required of the employee for this job. Duties, responsibilities, and activities may change at any time, with or without notice.
