API Technical Writer

1 нед. назад

USASenior

api documentationtechnical writingsoftware development

Lead creation and maintenance of high-quality API documentation and technical content to support API adoption and improve developer experience.

Обязанности

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.
Develop eLearning materials, training resources, and video-based instructional content when appropriate.
Collaborate with Marketing and other business teams to support technical sales collateral, website content, and developer-facing communications.
Establish and promote documentation standards, best practices, and governance processes.
Drive continuous improvements to the developer experience through effective content strategy and documentation planning.

Требования

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.
All qualified applicants will receive consideration for employment and will not be discriminated against on the basis of race, color, religion, sex, sexual orientation, gender identity, national origin, disability, protected veteran status, age, genetic information, or pregnancy.
Please beware of job seeker scams and see this important notice on our careers page for more information about our recruiting process.
Compliance Notice: Alten USA is a federal contractor subject to the requirements of the Vietnam Era Veterans’ Readjustment Assistance Act (VEVRAA) and Executive Order 11246. We are an Equal Opportunity Employer and consider all qualified applicants without regard to race, color, religion, sex, sexual orientation, gender identity, national origin, disability, or veteran status.
Drug Screening Requirement: As a federal contractor, Alten USA maintains a drug-free workplace. All candidates selected for employment will be required to successfully complete a pre-employment drug screening as a condition of hire.

Другое

We’re , an engineering company helping clients bring groundbreaking ideas to life—from advancing space exploration and life-saving medical devices to building autonomous electric vehicles. With 3,000+ experts across North America, we partner with leading companies in aerospace, medical devices, robotics, automotive, commercial vehicles, EVs, rail, and more.
As part of the global ALTEN Group—57,000+ engineers in 30 countries—we deliver across the entire product development cycle, from consulting to full project outsourcing.
When you join , you’ll collaborate on some of the world’s toughest engineering challenges, supported by mentorship, career growth opportunities, and comprehensive benefits. We take pride in fostering a culture where employees feel valued, supported, and inspired to grow.
We are seeking an experienced API Technical Writer to lead the creation, maintenance, and evolution of high-quality API documentation and supporting technical content. The ideal candidate combines strong technical writing expertise with a solid understanding of APIs, software development environments, and documentation best practices. This individual will be comfortable working independently, partnering with technical stakeholders across the organization, identifying documentation gaps, and driving a strategic documentation roadmap that improves the developer experience and supports API adoption.