ALTEN Technology USA logo
ALTEN Technology USAPosted 1 week ago

API Technical Writer

On-siteGreensboro, North Carolina, United States

Full TimeMediumTECH

Job Summary

Create, maintain, and continuously improve comprehensive API documentation, including endpoints, parameters, authentication methods, sample code, error messages, FAQs, onboarding guides, and release notes. Translate complex technical concepts, API functionality, and business use cases into clear, accurate, and user-friendly documentation for both internal and external audiences. Review existing documentation to identify gaps, inconsistencies, outdated content, and opportunities for improvement. Develop and manage a documentation backlog and roadmap, prioritizing initiatives that enhance usability, adoption, and overall documentation quality. Partner closely with software engineers, service owners, solution experts, product stakeholders, and other subject matter experts to gather information and ensure technical accuracy. Create tutorials, implementation guides, use-case documentation, diagrams, knowledge articles, and other supporting content to facilitate API adoption and successful integrations. Establish and promote documentation standards, best practices, and governance processes. Drive continuous improvements to the developer experience through effective content strategy and documentation planning.

Required Qualifications

  • Proven experience as an API Technical Writer, Technical Writer, or similar role focused on software documentation
  • Demonstrated experience creating and maintaining API documentation for technical and developer audiences
  • Strong understanding of APIs, web services, software development concepts, and integration workflows
  • Ability to understand technical architectures and translate complex information into concise, easy-to-understand documentation
  • Experience working with developers, architects, product teams, and other technical stakeholders to gather requirements and validate content
  • Exceptional written and verbal communication skills, with excellent formal and technical English
  • Strong organizational skills and the ability to manage multiple projects and priorities independently
  • Experience assessing existing documentation, identifying content gaps, and developing documentation strategies and roadmaps
  • Ability to work proactively with minimal supervision and take ownership of documentation initiatives from planning through delivery
  • Experience creating tutorials, onboarding materials, knowledge base articles, training content, diagrams, and related technical resources
  • Familiarity with documentation tools, content management systems, developer portals, and documentation best practices
  • Strong stakeholder management, collaboration, and relationship-building skills
  • Detail-oriented mindset with a focus on accuracy, consistency, and quality
  • Must successfully complete a pre-employment drug screening as a condition of hire

Hiring someone like this?

Get your role in front of qualified candidates on Sorce.

Get started

Apply to this job in one click with Sorce

Apply on Sorce