Do you have a passion for making technology easy to understand and use &Have you worked with APIs
- We are seeking a Technical Writer to help us create world class API Products for our Developer Portal.
- We treat APIs as products. Our API Technical Writers are imbedded in our product scrum teams.
- They work hand in hand with engineering, product owners, analyst and QA to documentation and explain our APIs.
- As a candidate, you understand how APIs are accelerating and disrupting markets and you apply that knowledge to create beautiful well-organized documentation.
- You may also have some instructional design background that provides perspective on how developers learn.
- You’ll work with internal API product teams to ensure API documentation is accurate, style is professional, adheres to company standards, ADA, and is consumable via. an Grav/Symphony or AEM CMS based API Developer Portal for external partners.
- Candidate is an experienced and proficient technical writer with excellent written and verbal communication skills.
- The successful candidate uses a thorough process of audience analysis, user-centric-design, and online authoring to develop and maintain API documentation, reference manuals, operational run books, videos, and other required systems documentation necessary to grow an online development community.
- Candidate possess excellent verbal and interpersonal communications skills, a thorough knowledge of personal computers and personal computer-based tools for developing technical documentation.
- Participates in the development of software API documentation standards, automated templates, portal governance, and publishing workflows.
- This is an exciting role for a Technical Writer who likes to work with engineering teams, has a start-up mentality, adaptability to change, and a get-it-done approach to execution.
You will:
- Drive the strategy and planning for product documentation in collaboration with engineering and commercial product owner teams.
- Write clear and concise API documentation for the bank’s external partners and developer personas.
- Develop code samples, interactive tutorials, and process flows to help developers get up to speed quickly.
- Democratize the documentation process across the API developer platform, serving as an editor for contributing engineers.
- Work with product managers, developer evangelists, designers, and marketing to shape the entirety of the developer experience, including community development and developer outreach.
- Work cross-functionally with our product teams, other engineering teams, and partner developers in the design and delivery of global developer platform.
- Contribute occasionally to internal documentation initiatives.
Qualifications
- 2+ years experience with RESTful APIs, JSON, Swagger or a similar framework, code commenting tools, and/or source code repositories preferred.
- Proficient writing in English. Ability to communicate effectively in writing as appropriate for the needs of the intended audience.
- Comfortable working in a semi-structured writing environment with evolving processes and homegrown systems.
- Comfortable handling multiple deadlines and self-prioritization of ad hoc requests.
- Experience working directly with engineers, product managers, and other stakeholders to help document (and define) new developer products and features.
- Experience writing common forms of developer documentation (API reference, conceptual guides, and tutorials).
- Experience writing Markdown and HTML by hand.
- Experience with CMS systems such as Grav, Symphony or AEM
Preferred Qualifications
- Agile/SCRUM Experience
- Experience with Git
- 4+ years of experience with CMS and Knowledge Management systems
- Training and knowledge transfer experience
- Some exposure to coding practices in Java, PHP, Python, and Ruby
- Desktop publishing concepts, practices, and usability procedures
- Develop professional quality documentation templates that enable automation and reuse.
- Edit, standardize, or make changes to material prepared by developers and initial API code authors.
- Collaborate with leadership, clients, and vendors, to establish technical specifications and to determine subject material to be developed.
- Analyse documentation to determine need for revisions in previously published materials and development of new material.
- Maintain records, files of work, and revisions for future use in content management system.
Essential Functions:
- Creates design principles and prepares technical and infrastructure architecture deliverables that meet business requirements and customer needs. Work is conducted in accordance to standards and methodologies and is consistent with the target business architecture strategy
- Participates in product design recommendations that span the entire infrastructure framework.
- Manage and prioritize the product and feature backlog for your products and APIs
- Lead the API/Micro-Services solution development and delivery, including hands on development
- Responsible for program design, coding, testing, debugging, documentation and preparing detailed specifications from which complex programs will be written.
- Provide application support, which includes problem research, analysis, resolution, and on-call support
- Work with QA/Testing groups to resolve issues and to ensure software quality
- Meet with clients to understand their needs and offer consulting services to internal groups.
- Develop and maintain APIs for multiple lines of business within an efficient Agile SDLC and act as an advocate for the API platform
- Builds technical relationships with business, operations, and technical teams and leads design efforts that provides innovative solutions and complex architectures
- Work cross-functionally with various Architects, Engineers, and Product owners across multiple teams in a rapidly evolving environment to translate business needs into API interface and functional requirements
Horizontal is proud to be an Equal Opportunity and Affirmative Action Employer. We seek to provide employment opportunities to talented, qualified candidates regardless of race, color, sex/gender including gender identity and/or expression, national origin, religion, sexual orientation, disability, marital status, citizen status, veteran status, or any other protected classification under federal, state or local law.
In addition, Horizontal will provide reasonable accommodations for qualified individuals with disabilities. If you need to request a reasonable accommodation in order to complete the application or interview process, please contact hr@horizontal.com.
All applicants applying must be legally authorized to work in the country of employment.
Success!
You have saved your first job! To see all your Saved Jobs, click here. Or continue scrolling through jobs and bookmark openings that catch your eye and apply for those jobs later.
We’re sorry!
There are currently no open positions in your location or accepting applications from out of the country
Return to Home