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.