OverviewDecisionPoint seeks an API Documentation Specialist to develop, maintain, and publish high-quality technical documentation supporting enterprise APIs within a large federal and DoD-aligned mission environment. This role curates Swagger/OpenAPI specifications, authors developer guides, maintains API portal content, and ensures all published documentation meets accessibility (508) and formatting compliance requirements.
The API Documentation Specialist collaborates closely with API developers, integration engineers, architects, cybersecurity teams, and product staff to ensure documentation is complete, accurate, usable, and aligned with enterprise API standards.
This position is fully remote.
Duties & Responsibilities
The API Documentation Specialist will:
- Maintain and update API documentation including Swagger/OpenAPI specs, data models, and schema descriptions.
- Develop clear, structured developer guides, integration instructions, and API usage examples.
- Publish and maintain content within the enterprise API portal, ensuring accuracy and discoverability.
- Ensure all API documentation and downloadable files are fully compliant with Section 508 accessibility requirements.
- Create diagrams, sequence flows, and integration illustrations to support developer understanding.
- Document authentication models, token flows, error codes, rate limits, and response structures.
- Work with API developers and architects to ensure documentation reflects current design and versioning.
- Support API version lifecycle documentation, including changes, deprecation notices, and migration guides.
- Manage documentation repositories, version control workflows, and content governance.
- Validate PDF and web formats for 508 compliance, tagging structure, and accessibility attributes.
- Participate in Agile ceremonies and support sprint-based documentation updates.
Qualifications
Clearance Requirement
Must hold an active Top Secret clearance, supported by a Tier 5 background investigation.
Education (Required)
Bachelor’s degree in Technical Writing, Information Systems, English, Communications, or a related discipline.
Experience (Required)
- Minimum 5 years of experience in technical writing, API documentation, or software documentation roles.
- Experience writing or editing API documentation, developer guides, or integration instructions.
- Experience maintaining Swagger/OpenAPI specifications or similar structured documentation formats.
- Experience producing accessible documentation compliant with Section 508.
Technical Knowledge (Required)
- Strong proficiency with API documentation tools (Swagger, OpenAPI, Redoc, Postman documentation, etc.).
- Understanding of RESTful API concepts, request/response patterns, authentication models, and schema design.
- Familiarity with Git-based version control for documentation updates.
- Knowledge of 508 compliance requirements for digital documents and PDFs.
Technical Knowledge (Preferred)
- Experience working with API gateways or developer portals.
- Familiarity with DoD cybersecurity requirements and secure API practices.
- Experience creating visual technical diagrams (sequence diagrams, architecture illustrations).
Certifications (Preferred)
- Technical writing certifications
- 508 accessibility or document compliance training
Skills
- Exceptional written communication and technical clarity.
- Ability to translate complex technical concepts into accessible, structured documentation.
- Strong attention to detail and commitment to documentation accuracy.
- Ability to collaborate effectively with cross-functional engineering and product teams.
- Strong organizational skills for managing versioning, updates, and multi-artifact documentation sets.
