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 documentation for 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.
    • Produce written guides for using GitLab features.
    • Help developers and other members of the community who have documentation-related questions.
    • Identify and address content gaps or the need for additional media such as diagrams or videos.
    • Participate in reviews and revamps of section or page content and structure.
    • Help review and triage incoming suggestions, corrections, and other content from the GitLab community.
  • 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.

    • Contribute to the planning and creation of new site features and enhancements.
    • Coordinate with frontend and backend engineers when their help is needed.
  • 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 easier for contributors from the community—internal and external—to submit quality documentation.
    • Contribute to the documentation Style Guide and documentation process guides.
    • Collaborate with and help improve upon collaborative processes with others including product managers, Support, Marketing, Engineering, and the wider GitLab community.

Requirements

  • You have:
    • Experience 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 using the Linux shell, command-line Git, HTML/CSS, and at least one programming language (does not have to be from a professional context),
    • Experience using static site generators and managing docs as code.
    • Experience with some of the following:
      • Using or documenting DevOps tools; especially deep experience with one or more GitLab DevOps Stage Groups.
      • 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.

Successful candidates will also be likely to bring experience with some of the following:

  • Using or documenting DevOps tools; especially deep experience with one or more GitLab DevOps Stage Groups
  • JavaScript and intermediate front-end development
  • Advanced programming or other technical experience
  • Using GitLab
  • A rapidly scaling start-up environment
  • Remote work; especially collaboration across borders and time zones