You are viewing a preview of this job. Log in or register to view more details about this job.

Software Technical Writers

Send an email to bharathkumar.sampath@halogion.com with the Subject “Software Technical Writers” showing your interest in the role to get priority consideration.

At Halogion, we are an Independent member of Mercor referral partner program. We refer candidates to our partner that collaborates with world’s leading AI research labs to build and train cutting-edge AI models

We are collaborating with a top-tier developer documentation team to support high-priority technical writing and content validation tasks. This opportunity is ideal for seasoned API documentation professionals with deep experience in OpenAPI/Swagger, release note generation, and static site deployment workflows. The goal is to enhance the clarity, completeness, and usability of technical content critical to developers' day-to-day integration work. This is a short-term, high-impact contract with flexible hours.

Key Responsibilities

Import and validate OpenAPI specifications; ensure syntax and schema completeness.

Write human-readable descriptions for endpoints, parameters, requests, and responses.

Create realistic usage examples and annotate rate limits, pagination, and authentication behavior.

Generate and deploy HTML reference documentation using static site generators (e.g., Docusaurus, MkDocs).

Review and categorize release changes from Git logs and issue trackers into user-friendly notes.

Test and verify code samples, markdown syntax, and internal/external links in documentation pull requests.

Troubleshoot and resolve documentation build failures via CI/CD pipelines and local environment testing.

Update knowledge base articles for accuracy post-product changes, including screenshots and version info.

Ideal Qualifications

5+ years of experience in technical writing or developer documentation roles.

Strong proficiency with OpenAPI/Swagger, Markdown, and static site generators.

Familiarity with Git, CI/CD workflows, and link-checking tools.

Experience documenting SDKs, APIs, CLI tools, or developer-facing UIs.

Attention to detail in writing, syntax, and formatting.

Ability to write concise, developer-focused documentation with minimal supervision.

More About the Opportunity

Remote and asynchronous — control your own work schedule

Expected commitment: min 30 hours/week

Project duration: ~6 weeks

Compensation & Contract Terms

$50–80/hour

Independent contractor arrangement

Paid weekly via Stripe Connect

Application Process

  • Submit your resume followed by domain expertise interview and short form