Skip to content
Snippets Groups Projects
Commit a24e1427 authored by Chloe Whitestone's avatar Chloe Whitestone :vulcan:
Browse files

cw add technical write

parent d342ad4e
No related branches found
No related tags found
1 merge request!6269cw add technical writer
Pipeline #
:markdown
The main difference between full and junior technical writers is their ability
to proactively and independently take on tasks to improve technical writing
assets.
:markdown
## Junior
Junior technical writers have similar responsibilities as outlined above,
but typically join with less experience in technical writing for similar
products.
:markdown
## Lead
The Technical Writing Lead leads the Technical Writing team. Their responsibilities include:
* Maintain a single source of truth across our sites, documentation and tutorials.
* Deliver input on promotions, function changes, demotions and firings in consultation with the CEO, and VP of Product
### Documentation
* Lead documentation improvement efforts.
* Create practices that encourage keeping documentation up to date and easily discoverable.
* Make sure by the time of release all documentation, guides and content.
### Tutorials
* Build out GitLab University so that everyone can quickly get started with GitLab.
* Create tutorials on a workflow designed around GitLab's defining features.
### Website
* Work with the Sales and Marketing team leads to make sure the website product content is comprehensive and up to date.
* Create a self-managing framework for the Community Writers program.
* Grow the Remote Only and Conversational Development websites.
It is not the responsibility of the Technical Writing team to write
documentation for new or updated features. All merge requests should include
comprehensive documentation written by the Development team.
:markdown
## Requirements
- Affinity for managing and writing technical documentation
- Understanding of what makes documentation good
- Excellent writing skills
- Great teaching skills that translate into amazing written work
- Highly organized
- Experience writing technical documentation for software
- You share our [values](/handbook/values), and work in accordance with those values
:markdown
## Responsibilities
### Documentation
* Document undocumented features.
* Maintain and update documentation.
* Improve the documentation UX.
* Coordinate with the Development team to ensure feature coverage and avoid overlap.
### Tutorials
* Write tutorials for getting started with GitLab features and advanced topics.
* Create video tutorials for the same content.
### Website
* Keep technical content on website up to date.
* Review Community Writer pitches and MRs.
It is not the responsibility of the Technical Writing team to write
documentation for new or updated features. All merge requests should include
comprehensive documentation written by the Development team.
---
layout: position_page
title: "Technical Writer"
salary: 65803
---
<%= partial "includes/positions/technical-writer/description" %>
<%= partial "includes/positions/technical-writer/responsibilities" %>
<%= partial "includes/positions/technical-writer/requirements" %>
<%= partial "includes/positions/technical-writer/lead" %>
<%= partial "includes/positions/technical-writer/junior" %>
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment