Technical Writer (API Documentation)-Remote(USA) only Visa independent candidates-W2 Role
Role: Technical Writer (API Documentation)
Location: Remote
Job Description:
Qualifications:
6-8+ years of relevant experience
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
Process-oriented and accustomed to Agile work environments and a start-up pace to projects
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 organize 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 up-to-date with industry best practices for API documentation and developer experience.
Required:
Bachelor's degree in Technical Communication, Computer Science, English, or a related field, or equivalent practical experience.
5+ years of 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 documenting RESTful APIs.
Exceptional writing, editing, and communication skills, with a keen eye for 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:
Experience with network protocols and technologies.
Familiarity with various API authentication and authorization mechanisms.
Understanding of software development lifecycles and agile methodologies.
Education:
Bachelor's in Electrical Engineering, Computer Science, Math, Statistics, etc.
Apply Now
Apply Now
Location: Remote
Job Description:
Qualifications:
6-8+ years of relevant experience
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
Process-oriented and accustomed to Agile work environments and a start-up pace to projects
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 organize 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 up-to-date with industry best practices for API documentation and developer experience.
Required:
Bachelor's degree in Technical Communication, Computer Science, English, or a related field, or equivalent practical experience.
5+ years of 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 documenting RESTful APIs.
Exceptional writing, editing, and communication skills, with a keen eye for 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:
Experience with network protocols and technologies.
Familiarity with various API authentication and authorization mechanisms.
Understanding of software development lifecycles and agile methodologies.
Education:
Bachelor's in Electrical Engineering, Computer Science, Math, Statistics, etc.
Apply Now
Apply Now