Senior API Technical Writer: REST & GraphQL Docs

Contiem, Inc.; Annapolis (MD); On-site; USD 80,000 - 110,000; Full time

Benefits offered by this job

PTO & holidays

Health/dental/vision insurance

401(k) with employer match

Professional membership reimbursement

Employee referral bonus

Job summary

Contiem, Inc. is seeking a Technical Writer with API experience to develop and maintain documentation for clients. The ideal candidate will work on RESTful and GraphQL services, translating complex concepts into clear, user‑friendly content.

You will collaborate with engineers, product managers, QA, and SMEs to publish API references, guides, and release notes, ensuring accuracy and adherence to standards.

Qualifications

• 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).
• 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.

Responsibilities

• 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.
• 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.
• 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.

Skills

Technical writing

API documentation

Editing AI-generated content

Cross-functional collaboration

Education

Bachelor’s degree in technical writing, journalism, communications, or related field

Tools

MadCap Flare

Microsoft Suite

Google Workspace

Adobe Creative Cloud

DITA XML

JSON

Markdown

HTML 5

Job description

Contiem, Inc. is seeking a Technical Writer with API experience to develop and maintain documentation for clients. The ideal candidate will work on RESTful and GraphQL services, translating complex concepts into clear, user‑friendly content.

You will collaborate with engineers, product managers, QA, and SMEs to publish API references, guides, and release notes, ensuring accuracy and adherence to standards.