Sr. Technical Writer I

HashiCorp

Summary

This job involves writing technical documentation for HashiCorp products, collaborating with various teams, and ensuring accurate and concise information architecture.

What you'll do

  • Review and help write documentation for new product features and functionality.
  • Organize existing documentation into a logical flow.
  • Collaborate with Engineering and Product to identify documentation gaps.
  • Gather feedback about documentation, identify areas of improvement, and implement solutions.
  • Empower others to write good documentation via templates, style guides, and clear information architecture.
  • Triage requests and decide what content should be published where.
  • Review documentation pull requests, which are submitted by a mix of software engineers, customer success, solutions engineers, and the general public.
  • Collaborate with Education Engineers to align terminology and knowledge, and to identify the proper formatting and placement for different kinds of content.
  • Become an informed user of a HashiCorp product (open source, cloud, and enterprise Terraform, Vault, Consul, or Nomad) and advise on explainability and terminology.
  • Identify cross-linking opportunities between documentation and product user interfaces, tutorials, and marketing materials.
  • Collaborate with engineering on intuitive naming and labeling conventions.

Requirements

  • Experience in technical writing for software, especially code driven or command line driven software
  • Familiarity with devops tools
  • Excellent written and verbal communication skills - this will be tested during the interview process and is required to be successful
  • Experience working on ongoing, multi-stakeholder projects
  • Experience structuring information to be easy to discover, navigate, and browse
  • Experience editing the work of other writers
  • Experience with Git and GitHub or another version control system
  • Experience with Swagger, OpenAPI, or similar automated documentation systems
  • Experience working with technical tools to validate information
  • Humility and curiosity, especially curiosity
  • Preferred: Hands-on experience in a technical field
  • Preferred: Experience with provisioning, security, networking, or orchestration technologies
  • Optional: Experience in teaching or education. This could be as a technical evangelist, tutor, or mentor
  • Optional: Passed any HashiCorp certification exam

Apply

Click below to be taken to the HashiCorp hiring page.

Location

United States

Compensation

$133,100 - $187,900 (per year)

Posted

3+ months ago

Category

Technical Writing

Keywords

git github swagger openapi