What the job involves
The main requirements, responsibilities and hiring steps.
Requirements
- Minimum of 7 years of experience in technical writing, with at least 3 years focused on OAS API documentation.
- Extensive experience with OpenAPI Specification (OAS).
- Familiarity with JSON language and YAML language.
- Swagger/OAS development experience.
- Experience in a software development environment.
- Strong understanding of RESTful APIs and related technologies.
- Excellent writing, editing, and proofreading skills.
- Proficiency with documentation tools such as Swagger, Postman, and Markdown.
- Ability to work independently and manage multiple projects simultaneously.
Nice to have
- Postman experience
- Visual Studio Code experience
- C# language experience
- API cataloging tools such as Azure Developer Portal or MuleSoft's Anypoint Exchange experience
Day to day
- Create and update detailed API documentation, including endpoint descriptions, request/response formats, error codes, and usage examples.
- Work closely with developers and product managers to understand API functionality and ensure accurate documentation.
- Ensure all documentation is clear, concise, and error-free. Continuously improve the quality and usability of documentation based on user feedback.