Overview
On Site
Depends on Experience
Full Time
Skills
API
RESTful
Technical Writer
Job Details
Job Responsibilities:
- Design, develop, and maintain high-quality external documentation for Network APIs, including API reference guides, integration tutorials, and usage examples.
- Work closely with product managers, engineers, and solution architects to understand API functionalities, features, and use cases.
- Translate technical specifications (e.g., Open API specifications) into comprehensive and understandable documentation for various technical audiences.
- Ensure accuracy, completeness, and consistency of all API documentation.
- Structure and coordinate information effectively for discoverability and ease of use on our developer portal.
- Collaborate with UX/UI designers to optimize the presentation and user experience of documentation on the developer portal.
- Incorporate feedback from internal teams and external customers to continuously improve documentation.
- Stay current on industry standard methodologies for API documentation and developer experience.
Job Requirements:
- Experience as a technical writer, with a strong focus on API documentation.
- Proven experience writing external-facing documentation for technical products.
- In-depth knowledge and hands-on experience with Open API Specification (OAS/Swagger) for defining and detailing RESTful APIs.
- Outstanding writing, editing, and communication skills, with a strong focus on detail and accuracy.
- Ability to grasp complex technical concepts and present them in a clear, concise, and accessible manner.
- Familiarity with developer portals and their role in API consumption.
- Proficiency with documentation tools and content management systems.
Preferred Qualifications
- Experience with network protocols and technologies.
- Familiarity with various API authentication and authorization mechanisms.
- Understanding of software development lifecycles and agile methodologies.
- Writing samples that demonstrate 3 years of experience drafting REST/RESTful APIs.
- Working knowledge of markdown languages.
- Able to grasp source code, architecture diagrams, and more.
- Comfortable with Agile work environments and fast-paced projects.
Education: Bachelor's or Master s degree in Computer Science, Computer or Electrical Engineering, Mathematics, or a related field.
Employers have access to artificial intelligence language tools (“AI”) that help generate and enhance job descriptions and AI may have been used to create this description. The position description has been reviewed for accuracy and Dice believes it to correctly reflect the job opportunity.