Logo
Jobs via Dice

Technical Writer Job at Jobs via Dice in Jersey City

Jobs via Dice, Jersey City, NJ, United States, 07390

Save Job

Overview

Technical Writer: Basking Ridge, New Jersey. Client - Verizon - 3 days a week Hybrid. Location: Basking Ridge, New Jersey.

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.

Qualifications

  • 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 or Master’s degree in Computer Science, Computer or Electrical Engineering, Mathematics, or a related field.

Seniority level

  • Mid-Senior level

Employment type

  • Full-time

Job function

  • Marketing, Public Relations, and Writing/Editing
  • Industries: Software Development
#J-18808-Ljbffr