Senior Technical Writer (API Documentation)-NetSec
Location
Bangalore | India
Job description
Your Career
As a member of the Network Security Technical Documentation team, you are integral to delivering the best product experience. In the role of a technical writer specializing in API documentation, you will be working closely with engineering to help our novice and experienced customers onboard and secure their data center, cloud, and secure access service edge (SASE) environments in a quick, automated way.
You will be actively involved in all stages of the release life cycle (conception, definition, development, release and post-release activities) and the tactical activities of documenting and evangelizing the features and capabilities of our Network Security platform. Your effort to produce detailed and engaging content will directly contribute to helping our users adopt our APIs and to generating fewer calls to our support organization. If you have a can-do attitude and take pride in delivering API documentation that is consistent and meets the needs of your users, we invite you to join a team that strives to deliver high quality content, in a creative, fun, and inclusive atmosphere.
Your Impact
- Enrich API reference documentation and supplement it with relevant sample code, including authoring API endpoint descriptions, responses, requests, query parameters, and data models
- Deliver quality content on schedule with frequent product releases
- Represent the customer by giving feedback to development teams about the API and OpenAPI specifications
- Partner with Developer Relations and Product Management to ensure the API documentation provides a quality experience for our customers
- Collaborate with other stakeholders to set up, configure, and deploy the product and new features to understand the end-to-end workflow
- Own the authoring and publishing processes to make content accessible to our users by improving existing processes, developing new processes, and training other writers on our evolving API documentation strategy
Your Experience
- Minimum 7 years of experience documenting technical content for a developer audience, including 5 years documenting REST APIs - You're comfortable testing API requests with Postman, and you're familiar with OpenAPI/Swagger
- Comfortable using the command line and Unix
- Familiarity with reading and writing code in 1-2 programming languages or other technical foundations
- Experience with source control tools (Git), bug tracking/collaboration tools (GitLab/Jira/Confluence), and build tools (GitLab)
- A hands-on approach to the technology and products being documented - Keen to learn new technologies quickly, and work in a fast-paced environment
- Experience with automating documentation publishing
- Ability to drive, follow, and evangelize cross-team processes, and collaborate with our customers and internal teams to improve documentation
The Team
The Palo Alto Networks TechDocs team directly helps our customers improve their security posture to best protect against cyber threats. As a part of the R&D organization, we work hands-on with products throughout the development cycle to serve as the voice of our users and to identify best practice workflows.
Job tags
Salary
