If you are a passionate and experienced API Documentation Engineer looking for a challenging and rewarding opportunity, we would love to hear from you
Job Title: API Documentation Engineer
Location: New York, New York, United States
Salary: $133000 - $160000
Job Overview: We are seeking an experienced API Documentation Engineer to join our dynamic and innovative team. As an API Documentation Engineer, you will play a critical role in creating and maintaining high-quality documentation for our API products. Your exceptional technical writing skills, attention to detail, and ability to understand complex technical concepts will be crucial in this role.
Key Responsibilities:
- Collaborate with cross-functional teams including Product, Engineering, and Support to understand API features and functionalities.
- Create and maintain clear and comprehensive API documentation for internal and external users.
- Research, gather, and organize technical information from various sources to create accurate and user-friendly documentation.
- Develop and maintain a documentation style guide to ensure consistency and clarity across all API documentation.
- Continuously review and update existing documentation to ensure accuracy and relevance.
- Implement version control for documentation to track changes and updates.
- Identify areas for improvement in the API documentation process and propose solutions to enhance the user experience.
- Work closely with the development team to understand API updates and changes and reflect them in the documentation.
- Collaborate with the Marketing team to create customer-facing material such as tutorials, guides, and FAQs.
Qualifications:
- Bachelor's degree in Computer Science, Technical Writing, or a related field.
- 3+ years of experience in technical writing, specifically in API documentation.
- Strong understanding of API concepts, structures, and protocols.
- Proficiency in using API documentation tools such as Swagger, Postman, and Git.
- Excellent written and verbal communication skills.
- Ability to break down complex technical concepts into simple and easy-to-understand language.
- Experience working in an Agile development environment.
- Detail-oriented with exceptional proofreading and editing skills.
- Self-motivated with the ability to work independently and in a team.
Why Work With Us: At our company, we value innovation, collaboration, and growth. As an API Documentation Engineer, you will have the opportunity to work with a diverse and talented team, and contribute to our mission of providing high-quality API products to our users. We offer a competitive salary, comprehensive benefits, and a flexible work environment that promotes a healthy work-life balance.
Apply now and join our team of API experts!