Resources Online is looking for a freelance technical writer who has experience delivering high-quality API documentation. This technical writer can create REST API reference content and guides that will advance our client’s API developer community.
Does this describe you? If so, let’s talk!
You have proven experience transforming REST API concepts into useful and actionable guidance for developers.
You can point us to published works or can provide samples that show your focus on customers and your deep technical understanding of API documentation.
You easily move from understanding REST APIs to explaining them to developers who need to use them.
This 40-hour-per-week, 2- to 3-month remote role will support community participation and customer engagement, retention, loyalty, and advocacy.
Tasks will include determining how and what information is presented and using customer comments, and requests about documentation to create and implement a content improvement plan.
Create documents on product features, pricing, and packaging before release, either from scratch or by leveraging previous documentation from product reviews, release notes, product specifications, or source code markdown.
Review software developer coding to understand outputs and to determine portions of codes that need definitions and descriptions to create API references.
Draft help systems, user guides, and API reference deliverables to meet customer needs.
Work closely and collaboratively with a cross-functional team that includes product management, product marketing, program management, user experience, engineering/development, customer support, QA, and professional services to build appropriate technical documentation.
Prepare content for online publishing, ensuring accuracy, consistency, and simplicity in design, usage, and support of adoption.
Five years of technical writing experience with SDK and API development and documentation
Experience with SaaS product content development for enterprise-class software
Experience documenting REST API and/or SDK information
Excellent research and analysis capabilities
Proven ability to work independently through the entire process of developing documentation (plan, design, write content, review, and publish)
Experience with markdown, swagger, or similar
Two or more years of IT or dev work
Experience in corporate, enterprise environment
As you know, there are many possible combinations of skills and experience that could qualify you. We’d love to hear what makes you not only a great technical writer but also the REST API writer we need. Get in touch! You can reach Resources Online at email@example.com. Send us a résumé and a tailored cover letter and, if your credentials seem like a good fit, we’ll get in touch. (No phone calls, please.)
Internal Number: 19RO2339-DS
About Resources Online
Resources Online is a Seattle-based digital firm focused on helping clients build their online presence. Resources Online specializes in building websites and digital content to accommodate and attract today's social and mobile users.
Since 1995, the people at Resources Online have delivered content and websites for clients large and small. We provide you with end-to-end services, or we can integrate with your existing in-house teams or vendors.
BACK TO TOP
Technical Communication Career Center is Just One of the Benefits.
Discover what else STC has to offer!
The job you are trying to reach from was originally posted at Technical Communication Career Center.