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
Never miss an opportunity! Create an alert based on the job you applied for.
