Commit 4202b036 authored by Sid Sijbrandij's avatar Sid Sijbrandij

Replace dry with ssot.

parent 084699a1
......@@ -71,7 +71,7 @@ After it is merged you can talk about it during the company call if applicable.
### Style guide and information architecture
1. **Don't Repeat Yourself** If you copy content please remove it at the origin place and replace it with a link to the new content. Think about the information architecture to eliminate repetition. Duplicate content leads to updating it in the wrong place, keep it [DRY](https://en.wikipedia.org/wiki/Don%27t_repeat_yourself).
1. **Single Source of Truth** 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 having to update it in multiple changes, which is a lot of work and very easy to forget. If you forget one of the pieces of content is out of date.
1. Make sure to always cross-link items if there are related items (elsewhere in the handbook, in docs, or in issues).
1. 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.
* At times, a change of perspecitve may be desired. In those cases, link to relevant sections of the handbook liberally. See the [onboarding template](https://gitlab.com/gitlab-com/people-ops/employment/blob/master/.gitlab/issue_templates/onboarding.md) as an example.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment