Technical Writer

Job Title: Technical Writer (API Documentation)
Location: Hybrid NYC, NY
Experience Level: 10+ years
Position Type: Contract

About the Role:

We are looking for an experienced Technical Writer with strong expertise in API documentation to join our team. The ideal candidate will have 8-10 years of experience creating and maintaining high-quality, user-friendly technical documentation. As a key member of our documentation team, you will work closely with developers and other stakeholders to document complex API functionality and make it easy to understand for a variety of audiences.

Key Responsibilities:

• Write, edit, and maintain clear, concise, and user-friendly API documentation.
• Collaborate with development teams, product managers, and other technical experts to gather information and ensure accurate, up-to-date content.
• Organize, structure, and format API documentation to ensure ease of use and accessibility.
• Review API specifications and other related documents to ensure that content meets standards and guidelines.
• Work with the Quality Assurance team to test API functionality and ensure documentation is consistent with actual API behaviour.
• Manage multiple documentation projects simultaneously, meeting deadlines and stakeholder expectations.
• Continuously improve documentation quality by incorporating user feedback and staying up-to-date with the latest API trends and tools.

Qualifications:

• 8-10 years of experience in technical writing, with a strong focus on API documentation.
• Solid understanding of RESTful APIs, JSON, XML, HTTP methods, and other web technologies.
• Experience with tools like Swagger, Postman, or other API documentation tools.
• Familiarity with version control systems such as Git.
• Exceptional writing, editing, and communication skills, with the ability to translate complex technical concepts into easy-to-understand documentation.
• Ability to work in a hybrid environment, requiring 3 days a week in-office.
• Strong attention to detail and a commitment to delivering high-quality documentation.

Preferred Qualifications:

• Experience with markdown, HTML, or other web development languages.

Background in working in an Agile environment.