API Technical Writer – Software Engineering Professional
Location: Greensboro, NC – Onsite
Engagement: 6–12 Months (Contract)
Onsite – Greensboro, North Carolina
Candidates should be comfortable working onsite and collaborating directly with technical, product, solution, and business stakeholders.
Job Description:
We are seeking an experienced API Technical Writer / Software Engineering Professional for a temporary 6–12-month engagement. The ideal candidate will have proven experience creating and maintaining high-quality API documentation and be highly proficient in formal, technical English.
The primary responsibility of this role is to develop clear, accurate, and user-focused API documentation that explains technical capabilities, supported business processes, and how APIs can be effectively utilized. Deliverables will include API reference documentation, tutorials, instructions, adoption guidance, and related technical content for both internal and external audiences.
The successful candidate will independently assess existing documentation, identify gaps and opportunities for improvement, establish and prioritize a documentation backlog, and drive enhancements through review and publication.
This role will work closely with service owners, developers, solution experts, and other technical stakeholders to understand and validate technical details, workflows, integrations, and documentation requirements.
The API Technical Writer will also collaborate with marketing copywriters to develop technically focused sales and marketing collateral, including solution briefs and web-ready content, ensuring that technical messaging is accurate, credible, clear, and aligned with go-to-market objectives.
Key Responsibilities:
- Own and maintain an improvement roadmap for API documentation by assessing existing content, identifying gaps, building and prioritizing a documentation backlog, and managing delivery timelines, deadlines, and review cycles.
- Gather technical requirements and insights by interviewing subject-matter experts, developers, service owners, and internal stakeholders.
- Create and maintain comprehensive API reference documentation, including endpoints, functions, parameters, sample code, error messages, and recommended usage patterns.
- Clearly explain how APIs interact with applications, systems, integrations, and business processes.
- Develop tutorials, instructions, onboarding materials, and adoption-focused content for internal and external audiences.
- Create and maintain developer-portal content, including Getting Started guides, onboarding documentation, authentication and credential setup, FAQs, troubleshooting information, release notes, and updates.
- Develop business cases and use-case narratives that demonstrate effective API utilization and business value.
- Develop adoption and learning assets across multiple formats, including documents, eLearning materials, and video scripts/storyboards.
- Produce or coordinate diagrams, workflows, illustrations, and other visual aids to clearly communicate products, processes, and integrations.
- Work closely with technical and solution experts to validate technical accuracy, workflows, terminology, and documentation requirements.
- Collaborate with marketing copywriters to develop technically focused sales collateral, including solution briefs and web-ready copy.
- Ensure technical messaging is accurate, technically credible, audience-appropriate, and aligned with go-to-market positioning.
- Incorporate stakeholder feedback and tailor documentation based on audience, tone, structure, terminology, and usability requirements.
- Proactively identify outdated, inconsistent, incomplete, or unclear documentation and drive improvements through completion and publication.
Required Skills and Experience:
- Proven professional experience as an API Technical Writer.
- Strong fluency in formal, technical English.
- Hands-on experience creating and maintaining API reference documentation, including:
- Endpoints
- Functions
- Parameters
- Sample code
- Error messages
- Strong understanding of how APIs interact with applications and business processes, including recommended usage patterns.
- Experience developing tutorials, technical instructions, onboarding materials, and adoption-focused guidance.
- Experience creating and maintaining developer-portal content, including:
- Getting Started/onboarding guides
- Authentication and credential setup
- FAQs and troubleshooting
- Release notes and updates
- Ability to independently assess existing documentation, identify gaps and inconsistencies, and establish and prioritize a documentation improvement backlog.
- Experience gathering requirements and technical information through interviews with internal stakeholders and subject-matter experts.
- Ability to incorporate feedback and tailor content for different audiences, including tone, structure, terminology, and level of technical detail.
- Experience working closely with service owners, developers, solution experts, and other product/technical experts.
- Experience developing business cases and use-case narratives demonstrating API usage, benefits, and business value.
- Experience developing adoption and learning assets across multiple formats, including documents, eLearning, and video scripts/storyboards.
- Ability to create or coordinate diagrams and other visual materials that clarify technical products, processes, workflows, and integrations.
- Experience collaborating with marketing copywriters to develop technically focused sales collateral, including solution briefs and web-ready content.
- Ability to ensure technical content is accurate, credible, clear, audience-focused, and aligned with go-to-market messaging.
- Strong organizational and project-management skills with the ability to independently plan and manage documentation delivery, including timelines, deadlines, priorities, stakeholder reviews, and publication cycles.
