API Documentation Specialist

This is a fully remote position, open to applicants in United States.

📋 Description

• Oversee the maintenance and updating of API documentation, which includes Swagger/OpenAPI specifications, data models, and schema descriptions.

• Create developer guides, integration instructions, and examples for API usage.

• Publish and manage content for the enterprise API portal.

• Ensure that API documentation and downloadable materials meet Section 508 accessibility standards.

• Generate diagrams, sequence flows, and illustrations for integrations.

• Document authentication models, token flows, error codes, rate limits, and response structures.

• Collaborate with API developers and architects to accurately reflect the current design and versioning.

• Assist with API version lifecycle documentation, covering changes, deprecation notices, and migration guides.

• Oversee documentation repositories, version control workflows, and content governance.

• Validate PDF and web formats for Section 508 compliance, including tagging structure and accessibility attributes.

• Engage in Agile ceremonies and support documentation updates based on sprint cycles.

• Work alongside integration engineers, cybersecurity teams, and product staff to ensure that documentation is comprehensive, precise, user-friendly, and aligned with enterprise API standards.

⛳️ Requirements

• Must possess an active Top Secret clearance, backed by a Tier 5 background investigation.

• Bachelor's degree in Technical Writing, Information Systems, English, Communications, or a related field.

• A minimum of 5 years of experience in technical writing, API documentation, or software documentation roles.

• Proven experience in writing or editing API documentation, developer guides, or integration instructions.

• Familiarity with maintaining Swagger/OpenAPI specifications or similar structured documentation formats.

• Experience in producing accessible documentation that complies with Section 508.

• Strong command of API documentation tools, such as Swagger, OpenAPI, Redoc, and Postman documentation.

• Understanding of RESTful API concepts, request/response patterns, authentication models, and schema design.

• Knowledge of Git-based version control for documentation updates.

• Awareness of Section 508 compliance requirements for digital documents and PDFs.

• Preferred: Ability to obtain or possess knowledge of API gateways or developer portals.

• Preferred: Familiarity with DoD cybersecurity requirements and secure API practices.

• Preferred: Experience in creating visual technical diagrams.

• Preferred: ITIL v4 Foundation certification.

• Preferred: Technical writing certifications.

• Preferred: Section 508 accessibility or document compliance training.

• Exceptional written communication skills and technical clarity.

• Ability to convert complex technical concepts into accessible and structured documentation.

• Strong attention to detail and commitment to documentation accuracy.

• Capability to collaborate effectively with cross-functional engineering and product teams.

• Strong organizational skills for managing versioning, updates, and multi-artifact documentation sets.

🏝️ Benefits

• Fully remote work arrangement.

• Equal Employment Opportunity and Affirmative Action employer.

• Pay transparency protections.

• Opportunity to be considered for other available positions requiring comparable skills, education, and experience.