Need to understand how to document and manage API’s
Client provides an API to customers who license our content and we need to spend time this year improving the experience for their users, most of whom are developing in Python and Java. Biggest part of the job is updating the documentation, including providing more detailed descriptions of the XML and JSON formats that are produced by the API.
The Role
We are seeking a detail oriented Technical Writer who can write documentation and help create supporting materials and artifacts in support of an API product that is used as part of a content licensing platform.
Tasks Will Include Working With SMEs On The Following
Reviewing and updating user documentation
Drafting supporting materials such as a briefing document, sales collateral, and PowerPoints
Assembling artifacts such as example files, schemas and Document Type Definitions (DTDs), available technical documentation, and other supporting materials
Suggesting improvements on the website that houses supporting materials
Reviewing existing use cases and documenting additional use cases
Qualifications
Bachelor’s degree in Technical Communication, Information Technology, or Business Management
Strong documentation and writing skills including user documentation and web-based support
Ability to take ownership for assigned tasks and deliver on schedule.
Previous experience as a Technical Writer on Information Technology projects.
Agile Experience – Should have previous experience utilizing Scrum.
Familiarity with solving problems and cultivating cross-group collaboration.
Sufficient familiarity with APIs and XML to be able to review and update technical documentation
Ability to think creatively and drive towards innovative solutions.
Demonstrated expertise in writing use cases sufficient for documentation.
At least 6 years of technical experience in a software development program.
At least 2 years of experience in m/UX design.
Familiarity with Google applications and XML
Ability to read technical documentation around API creations and general cloud concepts.
Desired Qualifications
Able to work with sponsors from different divisions with diverse perspectives.
A great communicator, with superb interpersonal skills.
Familiarity/experience with JIRA
Able to see the big picture while still having an eye for detail.
Able to provide examples of detailed technical documents, written by you.
Seniority level
Mid-Senior level
Employment type
Full-time
Job function
Marketing, Public Relations, and Writing/Editing
Industries
IT Services and IT Consulting
Referrals increase your chances of interviewing at Steneral Consulting by 2x