
Senior Technical Writer, API Docs
Addepar
full-time
Posted on:
Location Type: Remote
Location: Canada
Visit company websiteExplore more
Salary
💰 $87,000 - $109,000 per year
Job Level
About the role
- Take full ownership of developers.addepar.com, performing regular audits to ensure every endpoint and guide is accurate and functional.
- Create high-impact documentation for new features, consolidate redundant information, and proactively archive deprecated content to reduce technical debt.
- Rigorously test API documentation against live environments to verify accuracy, ensuring code snippets and examples work as intended.
- Evaluate and implement strategies to leverage AI and automation tools that keep content updated in real-time.
- Become the internal expert on ReadMe’s suite of AI tools. Implement best practices for automated API documentation and leverage AI-driven insights to improve the developer experience.
- Establish workflows that follow automated API documentation guidance to ensure the "completeness" of our technical library.
- Work closely with Engineers and Product Managers to translate complex technical specifications into clear, concise, and developer-friendly documentation.
Requirements
- 5+ years of experience writing API documentation (RESTful, GraphQL, etc.)
- Comfortable reading code (Python, Java, or similar) and using developer tools like Postman, GitHub, and CLI environments.
- Deep experience with ReadMe or similar documentation platforms. Knowledge of Markdown and "docs-as-code" workflows is essential.
- A forward-thinking mindset regarding AI. You should be familiar with LLMs and how structured documentation feeds into AI-driven support and development tools.
- An obsessive eye for detail. You understand that in the world of APIs, a single missing character can break an integration.
- Ability to distill highly complex backend logic into simple, actionable guidance for external partners.
- Ability to manage varied workloads and tight timelines, communicating across multiple time zones.
- High emotional intelligence. People enjoy working with you!
- An inspiring portfolio that showcases how you approach API documentation.
Benefits
- bonus
- equity 📊 Check your resume score for this job Improve your chances of getting an interview by checking your resume score before you apply. Check Resume Score
Applicant Tracking System Keywords
Tip: use these terms in your resume and cover letter to boost ATS matches.
Hard Skills & Tools
API documentationRESTfulGraphQLMarkdowndocs-as-codePythonJavaautomationtechnical writingcontent management
Soft Skills
attention to detailcommunicationtime managementcollaborationemotional intelligenceproblem-solvingadaptabilitycreativitycritical thinkingorganizational skills