Senior API Documentation Specialist for Developer Tools

Contiem; Annapolis (MD); On-site; USD 90,000 - 130,000; Full time

Benefits offered by this job

PTO & holidays

Health insurance

401(k) 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 our clients.

The role focuses on API documentation, tutorials, and developer portals, collaborating with engineers and SMEs to ensure accuracy and clarity. The ideal candidate will have 5-7 years in technical writing, strong writing skills, and experience with MadCap Flare, DITA XML, JSON, and API testing tools.

Qualifications

• Bachelor’s degree in technical writing or related field.
• 5-7 years’ experience in technical writing as primary function.
• Experience documenting APIs and developer tools.
• Proficient with MadCap Flare and DITA XML.
• Experience testing APIs using Postman or similar tools.

Responsibilities

• Develop, maintain, and publish API documentation for RESTful and GraphQL services.
• Create user guides, online help, installation guides, and tutorials.
• Validate API functionality and update docs to reflect product changes.
• Collaborate with engineers, product managers, QA, and SMEs throughout the lifecycle.

Skills

Technical writing

API documentation

Cross-functional collaboration

Editing AI-generated content

API testing awareness

Education

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

5-7 years of technical writing experience

Tools

MadCap Flare

DITA XML

JSON

Markdown

HTML5

Microsoft Suite

Google Workspace

Adobe Creative Cloud

Postman

Job description

Contiem, Inc. is seeking a Technical Writer with API experience to develop and maintain documentation for our clients.

The role focuses on API documentation, tutorials, and developer portals, collaborating with engineers and SMEs to ensure accuracy and clarity. The ideal candidate will have 5-7 years in technical writing, strong writing skills, and experience with MadCap Flare, DITA XML, JSON, and API testing tools.