API Documentation Specialist
New
D
DecisionPoint CorporationAPI documentation
Source API remote eligibility restrictions: United StatesFull-TimeSenior
Salary not disclosed
Apply NowOpens the employer's application page
Job Details
- Experience
- Minimum 5 years of experience in technical writing, API documentation, or software documentation roles.
- Required Skills
- GitRESTful APIs
Requirements
- Hold an active Top Secret clearance supported by a Tier 5 background investigation.
- Have a bachelor’s degree in Technical Writing, Information Systems, English, Communications, or a related discipline.
- Have at least 5 years of experience in technical writing, API documentation, or software documentation.
- Have experience writing or editing API documentation, developer guides, or integration instructions.
- Have experience maintaining Swagger/OpenAPI specifications or similar structured documentation formats.
- Have experience producing documentation compliant with Section 508.
- Demonstrate proficiency with API documentation tools such as Swagger, OpenAPI, Redoc, or Postman documentation.
- Understand RESTful API concepts, request/response patterns, authentication models, and schema design.
- Be familiar with Git-based version control for documentation updates.
- Know Section 508 requirements for digital documents and PDFs.
Responsibilities
- Maintain and update API documentation, including Swagger/OpenAPI specifications, data models, and schema descriptions.
- Develop developer guides, integration instructions, and API usage examples.
- Publish and maintain accurate, discoverable content in the enterprise API portal.
- Ensure API documentation and downloadable files comply with Section 508 accessibility requirements.
- Create diagrams, sequence flows, and integration illustrations.
- Document authentication models, token flows, error codes, rate limits, and response structures.
- Work with API developers and architects to keep documentation aligned with current design and versioning.
- Document API version lifecycle changes, deprecation notices, and migration guides.
- Manage documentation repositories, version control workflows, and content governance.
- Validate PDF and web formats for Section 508 compliance, tagging structure, and accessibility attributes.
View Full Description & ApplyYou'll be redirected to the employer's site
