Why This Role Stands Out
This role offers a fantastic opportunity to own and elevate API documentation strategy, directly impacting developer experience and showcasing your expertise in technical communication. You'll thrive here if you're a proactive, mid-senior technical writer eager to shape content, collaborate with diverse teams, and drive clarity for complex API systems within a reputable company. Apply now to build your career in a dynamic, on-site environment.
Quick Overview
Job Description
Job Title: API Technical Writer
Location : Greensboro, NC - Onsite
Duration: Long Term Contract
Client: TechM
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
Similar jobs
- SX
Technical Writer
Stem Xpert
San Jose, CA🇺🇸On-site10 years agoConfluenceTechnology - SX
Technical Writer
Stem Xpert
Salem, OR🇺🇸On-site12 years agoTechnology - SX
Technical Writer
Stem Xpert
Malvern, PA🇺🇸On-site11 years agoTechnology - SX
Technical Writer
Stem Xpert
Lansing, MI🇺🇸On-site10 years agoTechnology - LE
Sr. Technical Writer
Leidos
Gaithersburg, MD🇺🇸$82.5k - $149.2k/yrRemote5 days agoAgileConfluenceGit+2Technology - SR
Technical Writer III
Scientific Research Corporation
Charleston, SC🇺🇸Hybrid4 days agoCDNTechnology