Technical Writer - Contract / Part-time
Detalhes do emprego
Company Description At apibanking.com, we are solving the integration experience in open banking. Developer experience is critical to our vision - we want to make our products not only functionally great, but also delightful to use. We want to demystify the process of working with complex tech systems that make up most of banking today. If you are passionate about creating world-class API documentation that empowers developers and enjoy collaborating, we would love to hear from you. Role Description This is a contract / part-time (hybrid) role for a Senior Technical Writer at apibanking.com. The Senior Technical Writer will be responsible for collaborating with developers, product managers, and clients to deliver clear, concise, and accurate documentation that empowers users to integrate and utilize our APIs efficiently. The ideal candidate has a deep understanding of REST and SOAP APIs, integration specifications, and testing methodologies, and has experience in end-to-end documentation. Responsibilities
- Rewrite, update, and enhance API documentation, including: OpenAPI/Swagger specifications, developer guides, and narrative documentation that clarifies API use cases and workflows.
- Collaborate with cross-functional teams to gather information
- Analyze APIs, business processes and workflows
- Identify important components of APIs and document them accurately - such that other developers can use them effectively.
- Use OpenAPI and related tooling (e.g., Swagger, Postman, ReadMe.io, Stoplight.io) to validate API behavior and documentation.
- Ensure accuracy and consistency in content while adhering to the style guide and industry standard practices.
- Adapt to evolving content needs, formats, and cross-functional requirements to produce high quality guides, technical papers, training and tutorials, and more.
- Assist in user training and support, addressing inquiries and concerns.
- Bachelor's degree or equivalent, in Business, Finance, Computer Science, or a related field.
- 3-5 years of experience, and a proven track record as a Technical Documentation Writer, with expertise in financial services applications and API documentation
- Strong understanding of, and demonstrated proficiency in working with REST and SOAP APIs, integration / interface specifications, and data exchange protocols.
- Adept at using common authoring, publishing, graphic tools; open source authoring and source code management using Markdown, reStructured Text, Hugo, Git, and similar tools
- Proficient in information gathering
- Familiar with testing methodologies, including test case development and user acceptance testing
- Exceptional communication skills, both written and verbal, for effective collaboration.
- Detail-oriented mindset with excellent analytical and problem-solving skills.
- Familiarity and experience with project management principles and tools is be an added advantage
Apply safely
To stay safe in your job search, information on common scams and to get free expert advice, we recommend that you visit SAFERjobs, a non-profit, joint industry and law enforcement organization working to combat job scams.
