Technical Writer Cleveland - OH - Ohio

Job Title

Technical Writer (API)

Cleveland, OH

Contract

• Create API Documentation:
  Write API reference documentation, conceptual guides, tutorials, and tutorials.
• Document Structure:
  Detail API functions, parameters, data structures, authentication methods, and error messages.
• Maintain Content:
  Regularly update documentation to reflect new features, changes, and API versioning.
• Collaborate:
  Partner with developers, product managers, and engineers to understand functionality and ensure accuracy.
• Use Documentation Tools:
  Utilize tools like Swagger, OpenAPI, Postman, and Git-based systems (Git Hub, Git Lab) to generate or publish content.
• Gather Feedback:
  Collect feedback from internal teams and external developers to improve usability.
• Technical Proficiency:
  Strong understanding of RESTful APIs, JSON, and at least one or two programming languages.
• Writing
  
  Skills:
  
  Excellent, clear, and concise writing, with the ability to explain complex technical concepts simply.

• Experience Level: Generally, 3-5+ years in technical writing, often requiring prior experience in API-specific documentation.