Senior Technical Writer (API) - Part-Time
Remote or Durham, NC
Orbis Technologies, Inc. provides award-winning products, solutions, and services powering enterprise software for hundreds of clients across four continents and fourteen countries. Orbis software and services support mission-critical Enterprise Content Management Software, Solutions, Services, and Analytical Software Solutions. We make semantic technologies perform on a global scale. Every day, thousands of users at our prestigious commercial, military, and federal customers depend on our software and solutions. When other partners miss the mark, Orbis gets the job done.
Orbis is seeking a Senior Technical Writer with experience writing software documentation and an interest in getting into developer-oriented (API/SDK) and end user documentation. This is a position for a technical writer who has worked on multiple kinds of projects previously and enjoys applying their expertise and intellect to learning new things. It is a client-facing role, involving supporting various high-tech companies with their documentation production.
Remote work is available for this position.
Essential Duties & Responsibilities:
+ Develop content to clarify the users' understanding of the REST APIs using the software developer notes and your own understanding of the code: reference documentation, conceptual information, user and integration guides.
+ Annotate comment fields in JSON, YAML, HTML, XML, and other related file types.
+ Author content in MadCap Flare or related tools (e.g. Document! X).
+ Store content and manage version control using content repositories such as GitHub.
+ Collaborate with a team of writers, solutions architects, developers, project managers, subject matter experts, and other various stakeholders.
+ Ensure that the documentation you work on is accurate and follows clearly defined standards identified for a given project.
+ U.S. citizenship
+ 5+ years experience in technical writing with technical writing being your primary job function.
+ Bachelor's degree in technical writing, journalism, communications, or related field.
+ Aptitude for understanding software products and code.
+ Experience with researching and gathering relevant technical data from subject matter experts such as software developers and programmers, product managers, customer service managers, and as well as client resources, such as solutions design documents, JSON files, Jira tickets, and/or messaging tool comments.
+ Experience with: Visual Studio Code, NotePad++ or related editor; HTML, JSON, YAML, XML (preferred)
+ Some experience or at a minimum a conceptual grasp, interest, and aptitude for writing developer documentation, including knowledge of API reference and integration guides.
+ Possess excellent interpersonal and general business communication skills.
+ Experience working independently as well as in a team-oriented, collaborative environment.
+ Demonstrated success working in an environment driven by budget, scope, and deadlines across multiple clients/projects.
Preferred Skills & Qualifications:
+ Visual Studio Code, NotePad++ or related editor
+ REST API's
+ MadCap Flare
Optional Experience Preferences:
+ Oxygen XML Editor
+ Microsoft Visio
+ Adobe Illustrator
+ Adobe InDesign
+ Adobe FrameMaker
+ Microsoft Word
+ Adobe Acrobat Professional
+ Articulate 360
Please note, this job description does not cover or contain a comprehensive listing of activities, duties, or responsibilities required of the employee for this job. Duties, responsibilities, and activities may change at any time, with or without notice.
Work Hours & Location:
Part-time, remote position with hours of operations from Monday to Friday, between 8 am to 5 pm. Must be located in the United States.
Keyword: HTML, XML, SDLC, MadCap Flare, developer documentation, API, Visual Studio
From: Orbis Technologies