GitLab Handbook Usage
Was this helpful?
Was this helpful?
You are here:
GitLab Handbook Usage
A (process) problem comes up, frequently in an issue or chat.
A proposal is made in a merge request to the handbook.
Once merged, the change is announced by linking to the diff in the MR or commit. Major ones are posted in the #whats-happening-at-gitlab slack channel. Medium ones are posted in the #handbook channel for visibility, with a one line summary of the change. If there was an issue, close it out with a link to the diff.
Sometimes you want to have real time editing of a proposal during a meeting and you need to use a Google Doc for that. When doing so the first item should be the URL of the handbook page this content will be moved to when the meeting is over.
Documenting in the handbook before taking an action may require more time initially because you have to think about where to make the change, integrate it with the existing content, and then possibly add to or refactor the handbook to have a proper foundation. But, it saves time in the long run, and this communication is essential to our ability to continue scaling and adapting our organization.
This process is not unlike writing tests for your software. Only communicate a (proposed) change via a change to the handbook; don't use a presentation, email, chat message, or another medium to communicate the components of the change. These other forms of communication might be more convenient for the presenter, but they make it harder for the audience to understand the context and the implications for other potentially affected processes.
Having a "handbook first" mentality ensures there is no duplication; the handbook is always up to date, and others are better able to contribute.
When asked during an case study interview (shown above) about challenges related to being all-remote, GitLab co-founder and CEO Sid Sijbrandij provided the following reply.
The biggest problem is GitLab not working handbook first. We have an amazing handbook that allows us to collaborate, onboard new people, and think collectively.
However, it is counterintuitive to communicate changes to the handbook. The default of people, when they wish to communicate a change, is to send a Slack message, send an email, give a presentation, or tell people in a meeting — anything but make a change in the handbook.
It's slower for them. It's quicker to use any other form. If they make a change in the handbook, they first have to find the relevant part of the handbook, they sometimes have to adjust the handbook to make sure their change will fit in, they have to go through a technical process and a review or two, and they have to wait a bit before it's deployed.
It's slower than any other option. However, it allows people that commit a change after that to build upon a change. When they take that extra time, it's building a foundation for the next thing.
I think of it as brick laying. Every piece of information is a brick. At GitLab, there is a well-structured house, and everyone adds to that one house. Because we're pretty particular on how we build it, it has a strong foundation and we can build it very high.
In every other company, they send the brick into the hands of people. Everyone is receiving bricks daily that they have to add to the house they're building internally. They forget things and things are unclear. A lot of context has to be created because there is no context around where to place the bricks.
So, you can end up with a thousand houses that look quite different, that are all hanging a bit, and each time you add a brick to the top one pops out at the bottom. — GitLab co-founder and CEO Sid Sijbrandij
Please follow these guidelines and remind others of them.
Most guidelines in this handbook are meant to help, and unless otherwise stated, are meant to help more than being absolute rules. Don't be afraid to do something because you don't know the entire handbook, nobody does. Be gentle when reminding people about these guidelines. For example say, "It is not a problem, but next time please consider the following guideline from the handbook."
If you ask a question and someone answers with a link to the handbook, they do this because they want to help by providing more information. They may also be proud that we have the answer documented. It doesn't mean that you should have read the entire handbook, nobody knows the entire handbook.
If you need to ask a team member for help, please realize that there is a good chance the majority of the community also doesn't know the answer. Be sure to document the answer to radiate this information to the whole community. After the question is answered, discuss where it should be documented and who will do it. You can remind other people of this request by asking "Who will document this?"
When you discuss something in chat always try to link to a URL where relevant. For example, the documentation you have a question about or the page that answered your question. You can remind other people of this by asking "Can you please link?"
Remember, the handbook is not what we hope to do, what we should formally do, or what we did months ago. It is what we do right now. Make sure you change the handbook in order to truly change a process. To propose a change to a process, make a merge request to change the handbook. Don't use another channel to propose a handbook change (email, Google Doc, etc.).
The handbook is the process. Any sections with names like 'process', 'policies', 'best practices', or 'standard operating procedures' are an indication of a deeper problem. This may indicate a duplication between a prose description of a process and a numbered list description of the same process that should be combined in one description of the process.
When communicating something always include a link to the relevant (and up-to-date) part of the handbook instead of including the text in the email/chat/etc. You can remind other people of this by asking "Can you please link to the relevant part of the handbook?"
Everyone should subscribe to the #handbook channel to stay up-to-date with changes to the handbook
To change a guideline or process, suggest an edit in the form of a merge request.
After it is merged you can post this in the #whats-happening-at-gitlab slack channel if applicable. You can remind other people of this by asking "Can you please send a merge request for the handbook?"
When substantially changing handbook layout, please leave a link to the specific page of the review app that is directly affected by this MR. Along with the link, include as much info as possible in the MR description. This will allow everyone to understand what is the purpose of the MR without looking at diffs.
Communicate process changes by linking to the merged diff (a commit that shows the changes before and after). If you are communicating a change for the purpose of discussion and feedback, it is ok to link to an unmerged diff. Do not change the process first, and then view the documentation as a lower priority task. Planning to do the documentation later inevitably leads to duplicate work communicating the change and it leads to outdated documentation. You can remind other people of this by asking "Can you please update the handbook first?"
Like everything else, our processes are always in flux. Everything is always in draft, and the initial version should be in the handbook, too. If you are proposing a change to the handbook, whenever possible, skip the issue and submit a merge request. (Proposing a change via a merge request is preferred over an issue description). Mention the people that are affected by the change in the merge request. In many cases, merge requests are easier to collaborate on since you can see the proposed changes.
If something is a limited test to a group of users, add it to the handbook and note as such. Then remove the note once the test is over and every case should use the new process.
If someone inside or outside GitLab makes a good suggestion invite them to add it to the handbook. Send the person the URL of the relevant page and section and offer to do it for them if they can't. Having them make and send the suggestion will make the change and will reflect their knowledge.
When you submit a merge request, make sure that it gets merged quickly. Making single, small changes quickly will ensure your branch doesn't fall far behind master, creating merge conflicts. Aim to make and merge your update on the same day. Mention people in the merge request or reach them via Slack. If you get a suggestion for a large improvement on top of the existing one consider doing that separately. Create an issue, get the existing MR merged, then create a new merge request.
If you have to move content have a merge request that moves it and does nothing else. If you want to clean it up, summarize it, or expand on it do that after the moving MR is merged. This is much easier to review.
Try to add the why of a handbook process, what is the business goal, what is the inspiration for this section. Adding the why makes processes easier to change in the future since you can evaluate if the why changed.
Think about the information architecture to eliminate repetition and have a Single Source of Truth (SSoT). Instead of repeating content cross-link it (each text has a hyperlink to the other piece). If you copy content please remove it at the origin place and replace it with a link to the new content. Duplicate content leads to more work by having to update the content in multiple places as well as the need to remember where all of the out of date content lives. When you have a single source of truth it's only stored in a single system. Make sure to always cross-link items if there are related items (elsewhere in the handbook, in docs, or in issues).
A system of record (SoR) is the authoritative data source for a given data element or piece of information. It's worth noting that while it is possible to have a system of record that is also a single source of truth, simply just being a system of record doesn't directly imply it is the single source of truth.
The handbook is organized by function and result to ensure every item in it has a location and owner to keep it up to date.
It's essential that we adhere to this hierarchy and that we not maintain separate structures for company training materials (e.g. onboarding materials, how-tos, etc.), videos, or other documentation.
Adhering to this hierarchy is sometimes counter-intuitive. We've learned over the years that keeping content in context helps to ensure consistency when making future updates.
Instead, put the answer, link, definition, course, video, or test in the most relevant place. Use descriptive headings so that people can easily search for content.
That said, please mix formats where and when appropriate in the handbook, even within a single page. Utilizing multiple formats can be valuable, and different people may prefer certain formats over others.
Worry only about the organization per function and result, not about how the page will look if you embed varying types and formats of content.
Keep your handbook pages short and succinct. Eliminate fluff and get right to the point with the shortest possible wording. Keep in mind that the biggest challenge cited by new employees is the vast amount of information to take in during on-boarding.
Skills and behaviors of handbook first as a Team Member:
Actively contributes to the handbook.
Provides links information from the handbook when answering questions and if the information doesn't exist in the handbook, then the team member adds it.
Skills and behaviors of handbook first as a People Leader:
Holds their team and others accountable for being handbook first
Enables new team members and managers on how to leverage the handbook as a resource.
Serves as a role model for what it means to be handbook first.
For E-Group, information may need to be iterated on or MR branches may need to be created before it is made public. Outside of E-Group, temporary access may be granted on a project-specific basis.
Any MR you make on this project will only be available for viewing by the members of the group (gitlab-com-private)
When you are ready to make a merge request against the public repo do the following:
Set the Source Branch to your branch on the private repo.
Set the Target Branch to be gitlab-com/www-gitlab-com.
Click Compare Branch and Continue.
Then Submit Merge Request.
If you require project-based access, you can request temporary developer access in the #private_repo_auth_request Slack channel. The CLO is DRI on approvals. Membership will be audited on a monthly basis by the Sr. EBA to the CLO to ensure accuracy.
Any changes to the handbook as part of this review will be shared in the #handbook channel in Slack. People Operations Specialists will also ensure that questions asked in #questions are documented and all announcements on the company call have a relevant link.
It saves you the effort of needing to both update the handbook and create content for a presentation; the handbook is checked and improved as part of the preparation instead of extra work
The handbook will stay up to date so people don't look at an outdated information in a presentation
Seeing screenshots will confirm to people the content is in the handbook and it is up to date there
People get used to the structure of the handbook and can more easily find the relevant handbook section later on
The content is open for everyone to contribute to when it is in the handbook
The content is integrated with the rest of our processes and shown in context
Many more people will consume the content on a webpage than a presentation because it is easier to search and link
You're helping other organizations and students around the work by giving them an example how we do it
The presentation will look less polished, but the advantages outweigh that concern.
If a synchronous presentation is required, default to sharing your screen and viewing live handbook pages over a slide presentation.
Another company asked how we managed to work with the handbook because at their company it wasn't working: "There are many occasions where something is documented in the knowledge base, but people don't know about it because they never bothered to read or search. Some people have a strong aversion against what they perceive as a 'wall of text'."
To ensure that people's time is well spent looking at the handbook we should follow the 'handbook guidelines' above, and also:
Give real examples
In wikis it is impossible to make proposals that touch multiple parts of a page and/or multiple pages. Therefore it is hard to reorganize the handbook. Because GitLab Merge Requests and GitLab Pages are based on distributed version control you can split the role of submitter and approver. This allows for a division of work that keeps the handbook up to date:
Anyone who can read the handbook can make a proposal
Leaders (who tend to be short on time) only have to approve such a proposal
Wikis also do not encourage collaboration on changes, because there is no way to discuss a proposed change like there is with merge requests.
If you run into trouble editing the GitLab Handbook there are various means of help available.
GitLab team members with merge rights, are team members who have the GitLab permissions to merge merge requests (AKA: maintainer-level permissions). It is important that GitLab team members with maintainer permission use this responsibility responsibly. Below are a few guidelines for GitLab maintainers:
Avoid merging your own merge request until at least one other team member has reviewed your MR, unless it's a normal part of your role (such as PMs updating direction pages). Note: The exception to this rule is if you are modifying something very small (I.E. a typo)
When working to get your change merged quickly, make sure you are asking the appropriate team members with merge rights. Not sure who is responsible? Consult (and add to) the CODEOWNERS .
For example, CMO (Chief Marketing Officer) Staff members can approve any merge request that is specific to their function, while the CMO approves any merge request that is cross-functional marketing. Chief of Staff/CEO approves any merge request that has cross-company impact, such as GitLab's page.
Keeping up with changes to the Handbook can be difficult, please follow the with a particular focus on your merge request's title, to ensure someone reading the can quickly understand the MR's content.
When feasible, introduce process changes iteratively. It is important that you contribute to the handbook by . This will help gain adoption among the process's intended audience. We want to avoid significant process changes that are unnecessarily large, top-down, and disruptive. These types of process changes can disempower and cause people to focus on process rather than results.
At times, a change of perspective may be desired. In those cases, link to relevant sections of the handbook but don't include the content itself. See the as an example. Or for example a list of that links to performance indicators but doesn't duplicate definitions.
Avoid unstructured content based on formats like Learning Playbooks, , lists of links (such as quick links), resource pages, glossaries, courses, videos, tests, processes, standard operating procedure, training, or how-to's. These are very hard to keep up-to-date and are not compatible with organization per function and result. For example: Call it Contract Negotiation Handbook instead of Contract Negotiation Playbook
If a page includes more than two headings (especially if it's larger than a single "screen"), add an automatically generated Table of Contents (ToC) by copying ). Headings should have normal capitalization: don't use or ). After a heading, leave one blank line; this is , but it is our convention.
Strongly consider learning how to edit the and/or via the web IDE. Please read through the before contributing.
We don't need in our handbook, they make it harder to quickly open a file in editors. Don't add them, and delete them when you see them.
When mentioning currency amounts that team members may need to convert to their local currency (e.g. benefits, expenses, or bonuses), link those amounts to our section (e.g. ).
All documentation that also applies to code contributions from the wider community should be in the GitLab CE project (for example in or the ), not the Handbook, which is only for team members. Read more in the section of the Handbook.
The handbook is for things concerning current and future GitLab team-members only. If something concerns users of GitLab, it should be documented in the , the , the or the .
In an all-remote, asyncronous organization, each team member should practice handbook first. For more information on what it means to be handbook first, please refer to the section of this page.
From the , creating a commit or MR is just like any other project.
Open a MR in the .
Now the MR has been created against the and can be seen by the public.
Your MR will be available to the public now and after it has been merged in will be deployed to .
is an easy tutorial to follow from the command line to keep the private handbook up-to-date, until mirroring is working.
The handbook is a living document and we'll occasionally need to change URLs or move pages. This is for about.gitlab.com.
It is each department and team member's responsibility to ensure the handbook stays current. People Operations Specialists will partner with a representative from each department (engineering, marketing, etc) through weekly reviews to verify the content in the handbook is accurate and follows the same format as outlined in the . For questions on who to submit a merge request to, or assistance with the handbook, please reach out on the #handbook Slack channel.
If you need permissions to directly merge changes to the handbook, please submit a issue and follow the process for access approval. Request a 'Maintainer' role under www-gitlab-com. See for a full description of roles and permissions.
The Engineering team and all sub-teams track Handbook Update Frequency as a , with varying targets per team. Currently, Engineering is the only Division tracking Handbook update frequency, so as to analyse and observe the effectiveness of this KPI.
Presentations are great for ephemeral content like and board presentations. like a should be based on the handbook. This is an important element of .
In the creation of presentations for evergreen content, please screenshot the handbook and provide links to displayed pages rather than copy and pasting content (or formatting a slide specifically to mirror handbook information). This approach shows a , and rationale for this is below.
Also see some of the
We attempt to cover this in GitLab's .
Follow the
Have a great search function (we use Algolia), plus make it public so you can
Test people on their during onboarding
Avoid corporate speak, describe things like you're talking to a friend. For more, see our communications guide on .
Company handbooks . This format is more comfortable for people to work in than a static website with GitLab Merge Requests and GitLab Pages. However wikis tend to go stale over time, where they are badly organized and get out of date.
Remember that, like virtually everything we do, our handbook is , and we expect that other companies may use it as inspiration for their own documentation and practices. That said, the handbook should always be specific on what we do, not who we want to be, and every company will need to fill out their own handbooks over time. Our handbook falls under the .
If your company has been inspired by GitLab's handbook, we would love to know what inspired you. Please see our .
Every GitLab Handbook page has a search field near the top of the page for searching. See the page for tips on searching the handbook faster and more efficiently.
Team members, referred to as , are available to help you create a merge request or debug any problems you might run into while updating the GitLab Handbook.
For , especially ones that are time sensitive or prohibiting access to important information, there is an to reach out to team members who are on-call to help resolve the problem.
Ensure you have approval from the of the page you are merging prior to merging.