Technical Writer- API and ABI

5 Star Recruitment; Boston (MA); Hybrid; USD 80,000 - 110,000; Full time

Job summary

A leading recruitment agency is looking for a seasoned Technical Writer to create, edit, and maintain high-quality documentation. This role focuses on API and ABI documentation and requires collaboration with product managers, engineers, and other stakeholders to ensure clear communication of complex information. Candidates should have over 5 years of experience in technical writing, preferably with a background in software development and an understanding of blockchain and Web3 technologies. The position offers the opportunity to work in a dynamic environment with autonomy to explore creative solutions.

Qualifications

• 5+ years of experience as a Technical Writer focused on API and ABI.
• Experience with software development roles and financial institutions.
• Strong understanding of RESTful services and programming concepts.

Responsibilities

• Create, edit, and maintain high-quality documentation.
• Collaborate with cross-functional teams to meet user needs.
• Establish processes for efficient documentation delivery.

Skills

API documentation

Technical writing

Collaboration

Content strategy

User experience

Adaptability

Tools

Swagger

Postman

Confluence

JIRA

JSON

draw.io

Miro

Job description

About the job Technical Writer- API and ABI

The ideal candidate will be responsible creating, editing and maintain high-quality documentation that communicates complex technical information clearly and concisely to a variety of audiences. This role requires collaboration with subject matter experts, product managers, engineering team, and other stakeholders to ensure accurate and accessible content.

Key Responsibilities

• Provide expertise and guidance and best practices on product documentation set up for commercial purposes
• Review existing documentation related to product and applications and identify areas of improvement for our documentation strategy
• Work with UX team to optimize the setup of documentation on Resource Hub
• Work with Product, engineering and commercial teams to generate content and publish product requirements, operational flows, user and technical related material
• Establish standardized process and templates where possible for the efficient delivery of a consistent library of documentation for LedgerScan, CMP and Factory to include the following (not limited):
• User Guide
• Production functional features
• APIs and EndPoints (where applicable)
• ABIs and Scripts (where applicable)
• Workflow Diagrams
• Infrastructure Requirements
• Deployment Diagrams
• Assist with content generation and production of documents as necessary
• Assist in creating content strategies and documentation plans to support product development
• Collaborate with cross-functional teams to understand end-user needs and incorporate feedback

Skills and Experience Required

• 5+ years of experience as a Technical Writer, with a focus on API and ABI documentation
• 2+ years of experience in a software development role
• Experience with legacy financial institutions technology and API integration architecture
• Experience with Blockchain and Web3 technologies
• Strong understanding of APIs, RESTful web services, and programming concepts
• Proficiency with various authoring, CMS, and task management tools
• Familiarity with API documentation tools, such as Swagger, Postman, or similar
• Proficiency with Confluence, JIRA, and JSON
• Basic diagramming skills using tools like draw.io, Miro or similar
• Experience using tech stacks like Python, MongoDB, CDC, and Kafka
• Experience working in a fast-paced, dynamic environment
• Ability to thrive in an environment that grants you a lot of autonomy to explore creative solutions