- You are here:
- Product Roles
- Technical Writer
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.
- 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.
Additional responsibilities for Senior Technical Writers
- Documentation development
- Plan and complete large content initiatives such as section reviews and overhauls.
- 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.
- Act as a primary reviewer for other technical writers.
- Site features and user experience
- 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.
- 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 backlog and other needs.
Additional responsibilities for Staff Technical Writers
- Documentation development
- Lead the development of key documentation strategies including information architecture standards and improving product cohesiveness by helping to focus documentation on end-to-end use cases.
- Plan and execute content audits and overhauls, including of GitLab’s API and integration documentation, working with SMEs and technical writers.
- Documentation enablement and research
- Develop updated documentation processes, analyses, and standards that impact the work of the entire documentation team.
- Assess GitLab product content from third parties as well as GitLab’s blog and YouTube account to consider their incorporation/rewriting, linking, or indexing.
- Analyze competitor documentation content and features, working with others at GitLab concerned with competitive intelligence.
- Working with Product, build a collection of use cases mapped to product stages and features in order to assess information needs and the maturity of the docs in meeting those needs.
- Produce and analyze reports on documentation usage, structure, and production.
- Site features and user experience
- Plan and lead major documentation site feature enhancement initiatives.
- Optimize and document the team’s use of docs toolchains and third-party services such as search and analytics products.
- Leadership and collaboration
- Mentor other technical writers and lead documentation projects.
- Be the liaison with other teams or counterparts—for example, Support, Product Marketing, and UX—to develop and work on collaborative projects such as user research.
- 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
- 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.
Additional requirements for Senior Technical Writers
- Extensive experience as a technical writer.
- Experience producing documentation for a variety of products and services.
- Some 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 with static site generators, managing docs as code, and the nuances
of differing markup standards and rendering engines.
- Experience establishing processes used by teams across an organization in support
- Demonstration of the use of data and evidenced-based decision making.
- Experience with DevOps tools and some degree of front-end or back-end engineering.
Additional requirements for Staff Technical Writers
- Extensive experience as a senior technical writer.
- Experience producing documentation for a large variety of products and services including DevOps tools.
- Great research, planning, writing, editing, information architecture, and content strategy skills.
- Extensive 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 conceiving and implementing processes used by teams across an organization in support of documentation.
- Extensive experience with DevOps tools and coding.
Please note that if we are actively hiring for a position, you will see it
listed on our jobs page, where all of our current openings are
advertised. To apply, please click on the name of the role you are
interested in, which will take you to our applicant tracking system (ATS),
Avoid the confidence gap; you do not have to match all the listed
requirements exactly to apply. Our hiring process is described in more
detail in our hiring handbook.
GitLab Inc. is a company based on the GitLab open-source project. GitLab is
a community project to which over 1,000 people worldwide have contributed.
We are an active participant in this community, trying to serve its needs
and lead by example. We have one vision: everyone can
contribute to all digital content, and our mission is to change all creative
work from read-only to read-write so that everyone can contribute.
We value results, transparency, sharing, freedom,
efficiency, frugality, collaboration, directness, kindness, diversity and inclusion,
boring solutions, and quirkiness. If these values match your personality,
work ethic, and personal goals, we encourage you to visit our
primer to learn more. Open source is our culture, our way of
life, our story, and what makes us truly unique.
Top 10 reasons to work for GitLab:
- Work with helpful, kind, motivated, and talented people.
- Work remote so you have no commute and are free to travel and move.
- Have flexible work hours so you are there for other people and free to plan
the day how you like.
- Everyone works remote, but you don't feel remote. We don't have a head
office, so you're not in a satellite office.
- Work on open source software so you can interact with a large community and
can show your work.
- Work on a product you use every day: we drink our own wine.
- Work on a product used by lots of people that care about what you do.
- As a company we contribute more than we take, most of our work is released
as the open source GitLab CE.
- Focused on results, not on long hours, so that you can have a life and
don't burn out.
- Open internal processes: know what you're getting in to and be assured
we're thoughtful and effective.
See our culture page for more!
Work remotely from anywhere in the world. Curious to see what that looks
like? Check out our remote manifesto.