API Technical Writer — Developer Docs & Tutorials

Contiem; Annapolis (MD); On-site; USD 85,000 - 120,000; Full time

Benefits offered by this job

PTO 3 weeks

Paid holidays 8

Life events days 5

Medical/dental/vision

401(k) match

Membership reimbursement

Referral bonus

Job summary

Contiem, Inc. is seeking a Technical Writer with API experience to develop and maintain documentation for clients. The ideal candidate thrives in fast-paced environments, works with varying standards, and demonstrates strong writing skills.

Keys: API documentation for REST/GraphQL, collaboration with engineers and SMEs, and governance of documentation quality across projects. 5–7 years of experience and proficiency with MadCap Flare are preferred.

Qualifications

• Bachelor’s degree in technical writing, journalism, communications, or related field.
• 5-7 years’ experience in technical writing, with technical writing as primary function.
• Proficient in MadCap Flare or another help authoring tool.
• Experience testing APIs using Postman or similar tools.
• Experience reviewing and editing AI-generated technical content.

Responsibilities

• Develop, maintain, and publish API documentation for RESTful and GraphQL services.
• Document API endpoints, request/response schemas, auth methods, error handling, and workflows.
• Collaborate with engineers and SMEs to gather information and validate docs.
• Create and maintain API reference guides, developer portals, release notes, and changelogs.
• Produce code samples and implementation examples in common languages.

Skills

Technical writing

API documentation

Cross-functional collaboration

AI content editing

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

HTML5

Job description

Contiem, Inc. is seeking a Technical Writer with API experience to develop and maintain documentation for clients. The ideal candidate thrives in fast-paced environments, works with varying standards, and demonstrates strong writing skills.

Keys: API documentation for REST/GraphQL, collaboration with engineers and SMEs, and governance of documentation quality across projects. 5–7 years of experience and proficiency with MadCap Flare are preferred.