API Technical Writer

Job Description

Job Details:

Job Role: Technical Writer

Location: Tampa, FL or Chicago, IL or Jersey City, NJ

Duration: Full-Time

Job Summary: We are seeking a talented and detail-oriented API Technical Writer to join our growing team. As an API Technical Writer, you will play a crucial role in creating clear, concise, and comprehensive documentation for our application programming interfaces (APIs). Your documentation will be essential in assisting developers, partners, and clients in effectively understanding, integrating, and utilizing our APIs. You will work closely with cross-functional teams, including developers, product managers, and quality assurance engineers, to gather information and ensure accurate and up-to-date API documentation.


  1. API Documentation:
    • Create and maintain high-quality API documentation, including reference guides, developer guides, tutorials, and sample code examples.
    • Ensure that API documentation adheres to the company’s style guidelines, is user-friendly, and follows industry best practices
  • 2. Collaboration:
    • Collaborate with development teams to gather technical information and specifications needed for accurate API documentation.
    • Work closely with product managers and subject matter experts to understand the API’s functionality, use cases, and target audience
  • 3. Content Management:
    • Organize and structure the API documentation to provide easy navigation and findability for developers and users.
    • Keep the API documentation up-to-date with the latest API releases, changes, and improvements
  • 4. API Usability:
    • Evaluate API design and provide feedback to improve the clarity, consistency, and usability of API interfaces.
    • Advocate for developer-friendly APIs by suggesting improvements in API naming, versioning, error handling, and response formats
  • 5. Sample Code and Use Cases:
    • Develop and maintain code samples and use cases that demonstrate the proper integration and usage of APIs.
    • Ensure that the provided examples align with best coding practices and are relevant to real-world scenarios.
  • 6. API Release Notes:
    • Contribute to API release notes, communicating changes, enhancements, and bug fixes to developers and stakeholders
  • 7. User Feedback and Support:
    • Actively engage with developers, partners, and clients to gather feedback on API documentation and incorporate improvements based on user needs.
    • Provide support to users who have questions or encounter issues with the APIs.


  • Bachelor’s degree in Technical Communication, Computer Science, or a related field.
  • Proven experience (5+ years) as a Technical Writer, with a focus on API documentation.
  • Strong understanding of APIs, RESTful web services, and programming concepts.
  • Proficiency in writing clear, concise, and well-structured technical documentation.
  • Familiarity with API documentation tools, such as Swagger/OpenAPI, Postman, or similar.
  • Excellent communication and collaboration skills, with the ability to work effectively with cross-functional teams.
  • Attention to detail and a commitment to delivering accurate and user-friendly documentation.
  • Experience with markup languages (e.g., Markdown) and version control systems (e.g., Git) is a plus.
  • Prior experience in software development or exposure to coding languages (e.g., Python, JavaScript) is an advantage

To apply for this job please visit www.dice.com.