Wanted: An API Documentation Specialist Who Can Translate Developer Gibberish into Human Language (and Still Keep the Engineers Happy)
By That Documentation Guy Who Knows a "Simple API" Never Is Alright, here's the deal. We're
blueBriX
-- a healthcare tech company that's knee-deep in APIs, integrations, and data pipelines that keep hospitals, payers, and patients talking to each other (without breaking something important). We're not looking for a "copy-paste from Swagger" kind of writer. We need someone who can
decode complex tech
,
tell a clear story
, and
help developers actually use
what we build -- without them sending you Slack messages that start with "quick question." This is a
6-month remote contract
, perfect for someone who loves getting their hands dirty with APIs, documentation structures, and developer empathy.
You'll Know This Role is For You If:
You've stared at a JSON response long enough to see the matrix.
You know the difference between REST, SOAP, and RESTless developers.
You've ever explained OAuth to a non-tech person and lived to tell the tale.
You get a kick out of making complex systems look simple.
You think good documentation isn't an afterthought -- it's a product feature.
You secretly enjoy cleaning up chaotic Postman collections like a digital janitor.
What You'll Actually Be Doing (Besides Asking "Wait, What Does This Endpoint
Actually
Do?"):
Work with developers, product managers, and architects to
create clear, structured, and developer-friendly API documentation
.
Translate technical specs, code samples, and logic flows into
human-readable guides, tutorials, and references
.
Build and maintain documentation on platforms like
Swagger / OpenAPI, Postman, or Stoplight
, ensuring accuracy and version control.
Collaborate closely with Product and Engineering to ensure
docs evolve in sync with API updates
.
Create and organize
use-case examples, authentication guides, error handling docs, and integration walkthroughs
.
Review API design proposals and offer input to improve developer experience and consistency.
Advocate for documentation as part of the product lifecycle -- not the "we'll write it later" stage.
Reporting To:
The
Information Development Lead
(aka the person who believes words can save developers hours of confusion).
Metrics That Matter (AKA How We'll Know You're Not Just Rearranging Bullet Points):
Docs that developers actually read (and thank you for).
Reduced support queries that begin with "How do I...?"
Faster onboarding for new integration partners.
Fewer "version mismatch" issues in documentation.
Product and engineering teams saying, "This doc actually makes sense."
Qualifications:
5+ years of experience in
API documentation
(bonus if you've worked with healthcare or SaaS products).
Hands-on understanding of
REST APIs
, JSON, XML, and basic authentication mechanisms.
Experience using documentation tools like
Swagger / OpenAPI
,
Postman
,
Markdown
, or
Confluence
.
Familiarity with
developer portals
and version control (Git/GitHub).
Excellent writing and editing skills -- clarity, precision, and flow are your superpowers.
Ability to
collaborate remotely
and manage your own schedule without hand-holding.
The Gig:
Contract:
6 months
Type:
Remote (you can work from anywhere, as long as you're responsive and reliable)
Schedule:
Full-time contract engagement
We can't promise your APIs will always return 200 OK, but we can promise you'll make them look like they do. If you're ready to turn developer chaos into documentation clarity --
we're ready for you.
To learn more about blueBriX, please visit: https://bluebrix.health