API Technical Writer
Skills
API DocumentationInstructional VideosManualsOnline HelpSoftware DocumentationTechnical DocumentationTechnical Writers
What the job involves
The main requirements, responsibilities and hiring steps.
Requirements
- Proven experience of 5+ years as a Technical Writer with a focus on API documentation
- Proven experience using tools such as Jira, Confluence, Swagger, OpenAPI, Postman, Lucidchart, Apigee
- Strong understanding of APIs, RESTful web services, and programming concepts
- Experience creating training manuals, instructional materials, video tutorials
- Proficiency in writing clear, concise, and well-structured technical documentation
- Attention to detail and commitment to delivering accurate and user-friendly documentation
- Excellent communication and collaboration skills with the ability to work with cross-functional teams
Nice to have
- Attention to detail
- Excellent communication
- Collaboration skills
- Experience in software development or exposure to coding languages
- Proficiency in writing well-structured documentation
- Strong understanding of APIs
- Proven experience with API documentation
Day to day
- Create high-quality API documentation, including reference guides and tutorials.
- Improve existing API documentation to adhere to guidelines and best practices.
- Collaborate closely with engineers, product managers, and cross-functional teams to gather technical information.