Technical Writer:
We are seeking a skilled Technical Writer to document our cutting-edge network automation platform. In this role, you’ll work closely with project automation engineers, QA, and third-party support teams to create and maintain comprehensive documentation that empowers our users—mostly developers—to effectively deploy, operate, and troubleshoot our platform.
Key Responsibilities:
Develop and maintain clear, accurate, and user-centric documentation, including:
Product feature descriptions and configuration guides
Real-world use cases and network automation workflows
Test scenarios, expected outcomes, and validation steps
Lab setup instructions, topology diagrams, and infrastructure requirements
Troubleshooting steps, known issues, and best practices
Translate complex networking and automation concepts into accessible content for a range of users.
Collaborate closely with engineering and product teams to gather technical details and stay current with platform enhancements.
Create visual aids (e.g., diagrams, flowcharts, screenshots) to support written documentation.
Maintain documentation in sync with product releases and ensure version control.
Contribute to the evolution of our documentation framework and style guides.
Work with teams to address gaps in documentation based on user feedback.
Required Qualifications:
5+ years of experience in technical writing preferably in the networking or infrastructure automation domain.
Basic understanding of networking concepts (e.g., routing, switching, VLANs, VPNs, protocols) and network automation principles (e.g., Netconf, REST APIs, Ansible, Python scripting).
Experience documenting complex systems involving APIs, CLI/GUI interfaces, and automation workflows.
Strong command of written English, with the ability to simplify technical jargon for varied audiences.
Ability to read and interpret network topologies, configuration files, and automation scripts.
Preferred Qualifications:
Background in computer science, network engineering, or a related technical field.
Familiarity with tools and platforms used in automation pipelines (e.g., Jenkins, GitLab CI/CD).
Experience with virtual lab environments (e.g., EVE-NG, GNS5, Cisco VIRL, container-based testbeds).
Knowledge of YANG models, telemetry, or network intent-based systems is a plus.