Job code
IRC271096
Published on 14 julio 2025

Technical Writer-API Documentation IRC271096

Designation

Software Engineer

Function

Engineering

Experience

5-10 years

Location

United States - Basking Ridge NJ

Skills

Technical Writing, XML

Work Model

On-site

Apply

Description

  • 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 coordinate 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 current on industry standard methodologies for API documentation and developer experience.

Requirements

  • Outstanding writing, editing, and communication skills, with a strong focus on 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.

Job responsibilities

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

What we offer

Culture of caring. At GlobalLogic, we prioritize a culture of caring. Across every region and department, at every level, we consistently put people first. From day one, you’ll experience an inclusive culture of acceptance and belonging, where you’ll have the chance to build meaningful connections with collaborative teammates, supportive managers, and compassionate leaders. 

Learning and development. We are committed to your continuous learning and development. You’ll learn and grow daily in an environment with many opportunities to try new things, sharpen your skills, and advance your career at GlobalLogic. With our Career Navigator tool as just one example, GlobalLogic offers a rich array of programs, training curricula, and hands-on opportunities to grow personally and professionally.

Interesting & meaningful work. GlobalLogic is known for engineering impact for and with clients around the world. As part of our team, you’ll have the chance to work on projects that matter. Each is a unique opportunity to engage your curiosity and creative problem-solving skills as you help clients reimagine what’s possible and bring new solutions to market. In the process, you’ll have the privilege of working on some of the most cutting-edge and impactful solutions shaping the world today.

Balance and flexibility. We believe in the importance of balance and flexibility. With many functional career areas, roles, and work arrangements, you can explore ways of achieving the perfect balance between your work and life. Your life extends beyond the office, and we always do our best to help you integrate and balance the best of work and life, having fun along the way!

High-trust organization. We are a high-trust organization where integrity is key. By joining GlobalLogic, you’re placing your trust in a safe, reliable, and ethical global company. Integrity and trust are a cornerstone of our value proposition to our employees and clients. You will find truthfulness, candor, and integrity in everything we do.

About GlobalLogic

GlobalLogic, a Hitachi Group Company, is a trusted digital engineering partner to the world’s largest and most forward-thinking companies. Since 2000, we’ve been at the forefront of the digital revolution – helping create some of the most innovative and widely used digital products and experiences. Today we continue to collaborate with clients in transforming businesses and redefining industries through intelligent products, platforms, and services.

Apply Now

The gender information on this form helps us understand the makeup of our applicant pool in this key area, and to continuously improve our efforts to make our workforce more inclusive.

Drag and drop your file here or click here to upload

Only .docx, .rtf, .pdf formats allowed to a max size of 5 MB.

Alternately you can include your Linkedin profile