About the team:
We’re a unique collection of talented and passionate people with a shared vision of simplifying the complexity of modern application architectures. In order to meet our ambitious goals, we are searching for a technical writer to join our Documentation Team to create customer-facing documentation for our constantly evolving products (HAProxy Enterprise, HAProxy Fusion, HAProxy ALOHA, HAProxy Edge, and HAProxy Enterprise Kubernetes Ingress Controller).
We believe that robust documentation is essential for building an excellent customer experience. It also provides timely information to other teams within our organization, particularly Support.
What you will do in this role:
Technical writers on the Documentation Team blend the skills of a network administrator with those of a superb writer. Because the documentation must show steps on how to install and use the products, and those steps must be accurate, our technical writers are highly competent in the domain of information technology. You will likely need to set up a network, deploy servers, configure IP address routing, update firewalls, adjust DNS records, and create Docker containers. But equally important is good judgment when it comes to organizing ideas, creating a logical flow of concepts, adjusting examples so that they build upon one another, and removing excess from writing.
On the job, you will:
- Learn new software features as they are released and experience the product from a user's perspective. Often that includes installing and configuring the software, testing new features, and getting first-hand knowledge of how features work
- Translate complex product requirements documents, technical design and implementation specifications into simple and easily understandable documentation that is consistent with the target audience. At times, you may even need to inspect the source code
- Communicate with subject matter experts, ask them detailed questions that customers would ask, and boil down complex topics into procedures that are easy to follow, even for advanced use cases
- Understand why the features were added and what business value the new functionality provides
- Create user guides, online help, process documentation, functional specs and in-product support as needed
- Write content in Markdown using an IDE (for example, VS Code)
- Use Git for source control and version/revision management
- Ensure documentation is properly maintained, categorized, and consistent with related documents