The Apigee doc team designs, develops and delivers high quality API documentation and programming guides for API providers and application developers. We plan, research, write, release, and maintain documentation for our web-based applications, work with our developers and product management to understand the behavior and nuances of our products. We also work with out developer community to address real-world problems and create documentation that meets their needs.
We are looking for a candidate with 5+ years experience writing documentation for software products.
Job Description:
-
Write documentation for our web-based applications and public API.
-
Work with developers and product management to understand the behavior and nuances of our products.
-
Interact with developers in forums and Google groups to gather issues and discover what kinds of learning materials our users need.
-
Become an expert user yourself, to address the needs of users on all levels.
-
Package documentation and release notes for customer releases.
-
Contribute to ongoing departmental projects, including the style guide, templates, and tools development.
-
Work with the technical support and education teams to learn the areas in which our users need the most assistance.
-
Support our professional services and sales teams, helping them locate and understand then information they require and providing documentation updates to address immediate needs.
-
Have opportunities to influence product development and provide your unique point of view.
Requirements:
-
BA/BS in Technical Writing, English, Computer Science, or related degree or comparable experience.
-
Proven experience designing, writing, and testing API reference documentation.
-
Experience writing documentation for developer audiences.
-
Understanding of industry standard technologies & protocols (HTTP, WSDL, XML, SOAP, JSON, and REST).
-
Understanding of W3C XML Schema (XSD).
-
Basic ability to read, modify, and test sample code.
-
The ability to understand the perspective of any user, from novice to expert, and to communicate on that level with your writing.
-
The ability to create polished documents without the aid of an editor.
