
Technical Writer
Global All Time Zones Remote 3 Years Experience
JynAI is looking for Technical Writer to join our dynamic team. This is an exciting opportunity to significantly impact a rapidly evolving industry.
Skills
- 2+ years of experience in technical writing for SaaS products or developer platforms.
- Strong experience with API documentation, including REST APIs, OpenAPI/Swagger, and related tools.
- Hands-on experience with docs-as-code workflows using Markdown, Git, and static site generators.
- Ability to communicate complex technical concepts clearly to diverse audiences, including developers, end users, and business stakeholders.
- Excellent organizational skills, strong attention to detail, and the ability to manage multiple documentation projects simultaneously.
- Experience creating visual assets such as diagrams, screenshots, and flowcharts is a plus.
- Preferred: Experience working with AI/ML SaaS platforms or developer-focused tools.
Preferred Tools
- Documentation & Authoring: Markdown, Git, Docusaurus, Mintlify, Confluence, GitBook, MkDocs
- API & Developer Tools: Postman, OpenAPI
- Diagramming: Lucidchart, Mermaid
- Project & Task Management: Jira, Trello, or similar tools
Professional Skills
- Strong problem-solving abilities with keen attention to detail.
- Ability to work independently and manage multiple tasks effectively.
- Excellent written and verbal communication skills.
- Collaborative mindset with the ability to work well in cross-functional teams.
Key Responsibilities
Product Documentation
- Write and maintain clear, user-friendly documentation, including product guides, feature documentation, and release notes.
- Collaborate with product managers and engineers to document new features and product updates.
API Documentation
- Develop and maintain comprehensive API documentation, including:
Endpoint descriptions
Request and response examples
Authentication and error handling
Usage scenarios - Coordinate with engineering teams to ensure documentation accuracy and alignment with the latest API changes.
User Guides & Educational Content
- Create onboarding guides, step-by-step tutorials, FAQs, troubleshooting articles, and in-app help content for end users.
- Produce educational materials such as how-to guides, walkthroughs, and video scripts to support customer success and product adoption.
External Documentation Portal Management
- Set up and manage an external documentation site using platforms like Docusaurus, GitBook, or similar platforms.
- Organize documentation based on user needs (e.g., getting started, advanced usage, developer resources).
- Implement version control and feedback mechanisms for continuous improvement.
Cross-Functional Collaboration
- Work closely with engineering, product, support, and marketing teams to gather technical details, identify documentation needs, and clarify complex topics.
- Actively incorporate internal and external feedback to improve documentation quality and coverage.