Technical Writer

Requirements Responsibilities

As a Technical Writer at Leegality, you will be responsible for creating and maintaining a variety of technical documentation to ensure our users have the best possible experience with our products. Your main responsibilities will include:

API Documentation:

Develop comprehensive, user-friendly API documentation using OpenAPI specifications, with expertise in SwaggerHub.

Work closely with cross-functional teams to gather technical information and translate it into accessible documentation.

Knowledge Base:

Use a static site generator, preferably Docusaurus, to publish documentation on the knowledge base site.

Create and update Markdown and YAML documentation to provide a central repository for user guides, FAQs, and troubleshooting information.

Collaborate with subject matter experts to ensure accuracy and relevance of the Knowledge Base content.

Release Notes:

Own the creation of Release Notes for product updates, detailing new features, enhancements, and fixes.

Coordinate with development and product teams to gather information on upcoming releases and communicate changes effectively to users.

Other Support Documentation:

Author and update various support materials, including user manuals, installation guides, and tutorials.

Continuously improve and iterate on existing documentation based on user feedback and evolving product features.

Qualifications

Proven experience as a Technical Writer, preferably in a B2B saas company.

Strong proficiency in documenting APIs, software, and technical processes.

Excellent written and verbal communication skills with an ability to explain complex concepts in simple terms.

Experience using version control systems (e.g., Git) for tracking changes and collaborating on documentation projects.

Attention to detail and a commitment to producing high-quality documentation.

Preferred Qualifications

Proficiency in static site generators (preferably Docusaurus) and experience with Markdown, YAML, and other documentation tools.

Familiarity with API testing tools like Postman to validate and understand API behaviour.

Understanding of API design principles and the ability to read and understand code samples in languages relevant to your products (e.g., Python, JavaScript, Java).