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