API Technical Writer

Overview
Job Description

We are seeking a technical writer familiar with API documentation to maintain a developer doc portal. Someone with a strong technical grounding who should have experience with basic API documentation, Swagger/OpenAPI.

Key Responsibilities:

  • Collaborate with product managers, software engineers, and UX designers to gather requirements and technical specifications for APIs and developer tools.
  • Create and maintain API documentation, including API reference guides, getting started tutorials, code samples, and troubleshooting resources.
  • Utilize Swagger and OpenAPI specifications to document API endpoints, parameters, request/response schemas, and authentication mechanisms.
  • Work closely with development teams to ensure that documentation is aligned with product features, functionality, and updates.
  • Use Jira tickets to track documentation tasks, prioritize work, and coordinate with cross-functional teams.
  • Conduct regular reviews and audits of existing documentation to identify areas for improvement, updates, or revisions.
  • Provide support to developers and external partners by addressing inquiries, clarifying technical concepts, and troubleshooting documentation-related issues.
  • Stay informed about industry best practices, standards, and emerging trends in API documentation and developer experience.
  • Demonstrate flexibility and adaptability in a fast-paced and dynamic environment, adjusting priorities as needed to meet deadlines and business objectives.

Qualifications:

  • Bachelor’s degree in Computer Science, Technical Writing, or a related field; Master’s degree preferred.
  • Proven experience (3+ years) as a technical writer, with a focus on API documentation and developer tools.
  • Familiarity with Swagger and OpenAPI specifications for documenting RESTful APIs.
  • Experience using Jira for task management and issue tracking in an Agile development environment.
  • Some familiarity with Java programming language and related technologies.
  • Strong writing and editing skills, with the ability to communicate complex technical concepts clearly and effectively.
  • Detail-oriented with a commitment to accuracy, consistency, and quality in documentation deliverables.
  • Ability to work independently, manage multiple projects simultaneously, and meet deadlines.
  • Excellent interpersonal and communication skills, with the ability to collaborate effectively with cross-functional teams.

Benefits: 

  • Remote-first work environment (domestic US)
  • Branch-paid medical, dental, and vision insurance
  • Equity
  • 401k
  • Flexible time off
  • Paid company holidays
  • Paid parental leave (eligible after 6 months of employment)

Working at Branch

Branch is an equal opportunity employer and we value diversity at our company. We do not discriminate on the basis of race, religion, color, national origin, gender, sexual orientation, age, marital status, veteran status, or disability status.

A remote-first company with employees located all throughout the US, Branch emphasizes transparency, accountability, and trust to create a collaborative environment where our product, engineering, marketing, customer support, customer success, and sales teams can all thrive together.

Our teamwork has enabled us to become an award-winning fintech company, with Branch’s innovation and workplace recognized across industries. Branch has been honored by the Webby Awards, Benzinga Fintech Awards, Fintech Breakthrough Awards, Top Workplaces USA, Great Places to Work, and EY Entrepreneur of the Year, Heartland, among others.

Receive jobs from , on your whatsapp

Stay up to date with job opportunities, directly on your WhatsApp!
Receive instant notifications about the latest job openings in your region

Anúncio

Related Jobs

Related Jobs to API Technical Writer

Account Executive, Mid Market
279 days ago

We are looking for a seasoned Mid-Market Account Executive to continue driving LeadIQ’s suite of capabilitie...

Senior or Staff Frontend Engineer - React
369 days ago

We’re looking for an experienced full-time (or part-time) Frontend Software Engineer to join our engin...

Enterprise Account Executive
370 days ago

From the very beginning, SugarCRM had a unique vision: to offer a different kind of Customer Relationship Man...

Freelance English Transcriptionist (AMER/EMEA)
347 days ago

We are seeking a skilled and experienced Freelance Transcriptionist to join our team. As a Freelance Transcrip...

Clinical Care Navigator
370 days ago

Lyra is transforming mental health care through technology with a human touch to help people feel emotional...

Business Analyst
336 days ago

Piper Companies is seeking a Business Analyst to join a global investment company out of Wayne, PA. This...

Software Developer
301 days ago

AccuWeather is recognized and documented as the most accurate source of weather forecasts and warnings in the ...

Technical Writer - Security
352 days ago

We are looking for a Technical Writer to join our tech client’s commercial enterprise services team and wr...

Principal SEO
296 days ago

We are looking for a Principal SEO to guide the strategy for the company’s organic growth. This role involve...

Manager, Communications - People Team
370 days ago

We are seeking a dynamic and experienced Communication Manager to join our team and lead all internal team mem...

HR Business Partner
360 days ago

Headway’s mission is a big one – to build a new mental health care system everyone can access. We’v...

Account Executive
354 days ago

Adentro was created to solve one of the most important problems in the modern economy—the majority of consu...

Technical SEO Strategist
353 days ago

Ferguson is North America’s leading value-added distributor across residential, non-residential, new constru...

Healthcare Customer Service Representative
357 days ago

We’re obsessed with growth. From enabling companies to flourish, to helping careers bloom. SupportNinja wa...

Back-end Developer (Node.js)
344 days ago

The IT сompany Andersen invites a Back-end Developer (Node.js) to work on a large-scale project for our USA ...

Senior Product Manager
353 days ago

Are you passionate about building products from scratch? Are you ready to manage a product that influences h...

Software Engineer, Platform
371 days ago

Branch is on a mission to help working Americans grow financially. We do this by helping companies accelerate ...

Data Analyst
158 days ago

Today, we are working with businesses from various parts of the world, including North America, Western Europe...

Customer Experience and Insights Manager, Enterprise
358 days ago

Upwork ($UPWK) is the world’s work marketplace. We serve everyone from one-person startups to large, Fortune...

Software Engineer
259 days ago

Nelnet Business Services (NBS), a division of Nelnet, Inc., provides payment technology, education services, a...

Medical Communications Designer
370 days ago

We are seeking a talented and creative Medical Communications Designer to join our pharmaceutical industry cli...

Technical Consultant - MST or PST
182 days ago

PerfectServe offers best in KLAS assets in three categories: clinical communications, scheduling, and patient ...

Software Developer
Software Developer
314 days ago

At PNC, our people are our greatest differentiator and competitive advantage in the markets we serve. We are a...

Enterprise Account Executive
355 days ago

Density’s mission is to measure and improve our footprint on the world. We help companies understand how th...