Senior Technical Writer

  • GitLab
  • Remote
  • Sep 01, 2019
Full-time Technical Writing Remote-Friendly

Job Description

At GitLab, our team of technical writers is responsible for ensuring that the documentationfor all of our products is clear, correct, comprehensive, and easy to use. We are looking for great writers with strong technical proficiencies who will help our users succeed with our rapidly evolving suite of DevOps tools.

As part of our growing team, you’ll collaborate with GitLab engineers, who typically write the first draft of docs for the new features they create. You’ll dive in on special projects, planning and authoring new content and helping craft new doc site features and processes. You’ll collaborate with others across the organization to craft tutorials and other educational resources. You’ll be at the leading edge of DevOps while contributing to one of the world’s largest open-source projects and engaging with our wider community.

GitLab is an all-remote company and this is a remote position with no geographical requirements.

Responsibilities

  • Continuously improve GitLab’s documentation content in collaboration with engineers, product managers, and others.
    • Review and edit doc plans and content for all new and enhanced features.
    • Through the use and testing of GitLab and its documentation, as well as SME interviews, proactively identify information needs and content opportunities. Develop new content to meet those needs and plan further work for the technical writing team.
    • Plan and complete large content initiatives such as section reviews and overhauls.
    • Help developers and other members of the community who have documentation-related questions.
    • Help review and triage incoming suggestions, corrections, and other content from the community.
    • Act as a primary content reviewer for other technical writers.
  • Continuously improve GitLab’s documentation site features and user experience in collaboration with engineers and other technical writers. This may include the documentation site’s design, search, build process, feedback methods, SEO, visitor analytics, versioning, and other technical components.
    • Plan and lead documentation site feature enhancement initiatives.
    • Work with UX to identify contextual content/documentation opportunities in the product.
    • Produce reports on documentation usage and metadata.
  • Contribute to the improvement of team process and style, as well as cross-functional efforts.
    • Act as a reviewer of release blog posts and contributor to GitLab’s Handbook.
    • Make it easy for contributors from the community—internal and external—to submit quality documentation.
    • Contribute to the documentation Style Guide and documentation process guides.
    • Collaborate and improve upon collaborative processes with others including product managers, Support, Marketing, Engineering, and the wider GitLab community.
  • Leadership and collaboration
    • Mentor newly hired technical writers.
    • Lead projects when pairing with other technical writers.
    • Plan new cross-functional efforts.
    • Represent the team at hackathons or other community endeavors.
    • Plan and lead a portion of the team’s process-improvement initiatives.
    • Organize and prioritize portions of the team's work backlogs.

Requirements

  • You have:
    • Extensive experience planning, writing, and managing software documentation.
    • Excellent skills in writing, editing, research, and planning.
    • Understanding of what makes documentation clear and effective.
    • Great teaching skills that translate into amazing written work.
    • Experience establishing processes used by teams across an organization in support of documentation.
    • Experience planning and leading major initiatives such as the launch of new documentation resources, large-scale documentation reviews and overhauls, cross-functional initiatives, etc.
    • Experience using data and evidenced-based decision making.
    • Experience using Git on the Linux or Mac command line and developer tools and workflows.
    • Experience with a docs-as-code workflow, a markup language such as Markdown, AsciiDoc, or reStructuredText, and at least one programming language (though this does not need to be from a professional context).
    • Experience with some of the following:a
      • Using or documenting DevOps tools; especially deep experience with one or more GitLab DevOps Stage Groups.
      • Developing sites using static site generators.
      • JavaScript and intermediate front-end development.
      • Advanced programming or other technical experience.
      • Using GitLab.
      • A rapidly scaling start-up environment.
      • Remote work; especially in collaboration with others across countries and time zones.
  • You are:
    • Highly organized; able to triage and prioritize numerous issues and projects.
    • Able to succeed in a remote, globally distributed work environment. 
  • You share our values, and work in accordance with those values.