Technical Writer

Title: Technical Writer

Location: Greensboro, NC – Onsite

Description:

We have a temporary need (approximately a 6–12-month engagement) to onboard a consultant with proven API Technical Writer experience who is fluent in formal, technical English.

The primary objective is to produce high-quality API documentation that explains how our portfolio of commercial, retail and compliance work, the business processes they support, and why/how they can be used. Deliverables include reference documentation, tutorials, instructions, and adoption-focused guidance for internal and external audiences.

The writer is expected to independently identify, build, and continuously prioritize a backlog of documentation and text improvements across the API portfolios, proactively addressing gaps, inconsistencies, outdated content, and opportunities to improve clarity, accuracy, structure, and usability, and drive updates through to publication.

The API Technical Writer will work closely with internal product experts (e.g., service owners, developers and solution experts) to learn and validate technical details, workflows, and documentation requirements.

The API Technical Writer will also partner closely with marketing copywriters to develop technically focused sales collateral (e.g., solution briefs and web-ready copy), ensuring messaging is accurate, technically credible, aligned with go-to-market positioning, and clear for the intended audience.

Key Responsibilities:

• Own an improvement roadmap for API documentation: independently assess current content, build and prioritize a backlog, and plan delivery (timelines, deadlines, and review cycles).
• Gather requirements and insights by interviewing other team experts and internal stakeholders; incorporate feedback and tailor content (tone, structure, terminology) for target audiences to ensure understanding.
• Create and maintain API reference documentation (endpoints, functions, parameters, sample code, error messages) and explain how APIs interact with applications and business processes, including recommended usage patterns.
• Develop tutorials and adoption assets across formats (documents, eLearning, video scripts/storyboards) and produce business cases/use-case narratives showing effective API usage and value.
• Write and maintain general developer-portal content beyond API reference docs, e.g., Getting Started/onboarding guides, authentication and credential setup, FAQs/troubleshooting, release notes/updates, etc.
• Produce or coordinate diagrams and other visual aids (directly or with designers) to clarify products, processes, and integrations.
• Partner with solution experts to validate technical accuracy and collaborate with marketing teams to create technically credible sales collateral aligned to go-to-market messaging and ongoing initiatives.

Required Skills and Experience:

• Proven API Technical Writer experience.
• Fluency in formal, technical English.
• Experience creating and maintaining API reference documentation, including:
• Endpoints
• Functions
• Parameters
• Sample code
• Error messages
• Experience explaining how APIs interact with applications and business processes, including recommended usage patterns.
• Experience developing tutorials, instructions, and adoption-focused guidance for internal and external audiences.
• Experience creating and maintaining developer-portal content, including:
• Getting Started/onboarding guides
• Authentication and credential setup
• FAQs/troubleshooting
• Release notes/updates
• Ability to independently assess existing documentation, identify gaps and inconsistencies, and build and prioritize a documentation improvement backlog.
• Experience gathering requirements and technical insights by interviewing internal stakeholders and subject-matter experts.
• Ability to incorporate feedback and tailor content for target audiences, including tone, structure, and terminology.
• Experience working closely with service owners, developers, solution experts, and other product experts to validate technical details, workflows, and documentation requirements.
• Experience developing business cases and use-case narratives demonstrating effective API usage and value.
• Experience developing adoption assets across formats, including documents, eLearning, and video scripts/storyboards.
• Ability to produce or coordinate diagrams and other visual aids to clarify products, processes, and integrations.
• Experience collaborating with marketing copywriters to develop technically focused sales collateral, including solution briefs and web-ready copy.
• Ability to ensure technical messaging is accurate, technically credible, aligned with go-to-market positioning, and clear for the intended audience.
• Ability to independently plan and manage documentation delivery, including timelines, deadlines, and review cycles.