At Advisor360°, we hire people with all kinds of awesome experiences, backgrounds, and perspectives. We like it that way. So even if you don’t meet every single requirement, please consider applying if you like what you see. Though many of our roles are assigned to a particular office location, most are a hybrid of remote and in-person work.
We are seeking a skilled and detail-oriented Technical Writer to join our team and play a key role in documenting our Application Programming Interfaces (APIs).
The Technical Writer for APIs will work closely with our data science, software engineering, product management, and information security teams, as well as other stakeholders to create comprehensive and user-friendly API documentation that enables developers and end-users to effectively utilize our APIs. This position requires a strong command of technical writing, excellent communication skills, and a deep understanding of API concepts and technologies.
The role of a Technical Writer for APIs is crucial in ensuring that our APIs are effectively documented and that developers can seamlessly and securely integrate them into their projects. This position requires a blend of technical expertise, writing skills, and a commitment to delivering high-quality documentation that enhances the user experience.
- Collaborate with software developers and subject matter experts to gather information about the APIs.
- Write, edit, and maintain clear and concise API documentation, including guides, tutorials, reference materials, and release notes.
- Ensure that the documentation accurately reflects the API functionality, features, and best practices.
- Organize and structure the documentation to make it accessible and user-friendly.
API Testing and Hands-on Experience
- Familiarize yourself with the APIs by actively using and testing them to gain practical experience.
- Identify potential areas of improvement and provide feedback to development teams.
API User Assistance
- Create documentation that caters to different user levels, including beginner, intermediate, and advanced users.
- Develop troubleshooting guides and FAQs to help users resolve common issues.
- Collaboration and Communication
- Collaborate with cross-functional teams, including developers, product managers, and quality assurance, to gather information and address documentation needs.
- Communicate technical concepts clearly and concisely to a non-technical audience.
- Keep API documentation up-to-date with the latest releases and changes.
- Monitor feedback from users and update documentation accordingly.
- Manage versioning and document history for API changes.
Pre-Release, Release, and Post-Release Communications
- Support Product Managers in preparing release notes for new product launches and enhancements releases across our product suite.
- Support product education and partners in the production of training and help materials.
Style and Consistency
- Maintain a consistent writing style, tone, and format across all API documentation.
- Ensure that documentation adheres to industry best practices and standards.
- Ability to adapt writing style to different personas, including internal and external stakeholders who may be either technical or non-technical consumers of information.
- Bachelor's degree in a relevant field, such as Computer Science, Information Technology, or Technical Writing.
- Proven experience as a Technical Writer, with a focus on API documentation.
- Strong knowledge of API concepts, RESTful APIs, and web technologies.
- Strong understanding of information security protocols and best practices.
- Proficiency in using documentation tools and platforms (e.g., Swagger, OpenAPI, Markdown, Confluence).
- Excellent written and verbal communication skills.
- Detail-oriented with the ability to organize complex information logically.
- Familiarity with software development processes and tools (e.g., Git, JIRA) is a plus.
- Familiarity with machine learning, artificial intelligence, and large language model concepts and practices is a plus.
- Experience with developer-focused documentation and code samples is highly desirable.
Come grow with us! Join a team of inventive, driven professionals!
Launched in 2019, Advisor360° combines a start-up's agile and innovative markers with the stability of an established enterprise. Ranked the largest FinTech company in Massachusetts by the Boston Business Journal, Advisor360° was born out of 20 years of feedback from the industry’s highest-producing financial advisors and has gone on to build a software that is second to none.
Our company specializes in building, delivering, and integrating technology for wealth managers. Our comprehensive platform offers a unified approach to managing wealth, delivering a connected experience to advisors and their clients.
Benefits include a competitive bonus plan, unlimited paid time off, paid sick time, volunteer time off, free access to vacation homes, a generous 401(k) employer match, stock appreciation rights, referral bonuses, 80% of either HMO or PPO premiums for individuals and family employer covered, 50% of dental insurance paid for, employer life and AD&D at 2X salary, short- and long-term disability coverage, a health savings account, flexible spending accounts, and paid bonding time for new parents.
Advisor360° also provides worthwhile perks, including a hybrid structure with most employees working from the office 2 to 3 times per week, tuition reimbursement, professional development opportunities, employee assistance programs, and more!
Join us on this journey. Advisor360° is an equal opportunity employer committed to a diverse workforce. We believe diversity drives innovation and are therefore building a company where people of all backgrounds are truly welcome and included. Everyone is encouraged to bring their unique, authentic selves to work each and every day. The way we see it, we are here to learn from each other.
Are you ready to build and discover together?