Qualification
- Deep familiarity with API documentation (REST), OpenAPI/Swagger, and related tools.
- Experience with docs-as-code workflows using Markdown, Git, and static site generators.
- Ability to communicate complex ideas simply for various audiences (developers, end users, business stakeholders).
- Strong organizational skills, attention to detail, and ability to manage multiple documentation projects in parallel.
- 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, Mintly, Confluence, GitBook, MkDocs
API & Developer Tools : Postman, OpenAPI
- Diagramming : Lucidchart, Mermaid
- Project & Task Management : Jira, Trello (or similar)
Professional Skills
- Strong problem-solving abilities and attention to detail.
- Ability to work independently and manage multiple tasks simultaneously.
- Excellent communication skills, both written and verbal.
- Collaborative mindset with the ability to work effectively in a team :
- Product Documentation :
- Write and maintain clear, user-friendly product guides, feature documentation, and release notes.
- Collaborate with product managers and engineers to document new features and product updates.
- API Documentation
Develop And Update Comprehensive API Reference Material, Including
- Endpoint descriptions
- Request/response examples
- Authentication and error handling
- Usage scenarios
- Coordinate with engineering to ensure accuracy and reflect 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 Docs Portal Management
- Set up and manage an external documentation site using platforms like Docusaurus, GitBook, or similar.
- Organize documentation by user need (e.g., getting started, advanced usage, developer resources).
- Implement version control and feedback mechanisms for ongoing Collaboration :
- Work closely with engineering, product, support, and marketing to :
- Gather technical details
- Identify documentation needs
- Clarify complex topics
- Actively respond to internal and external feedback to improve documentation quality and coverage.
(ref:hirist.tech)
