Documentation

Common Mistakes - Repetition

• Do not restate information already covered earlier in the same page or in a linked topic
• Each section should add new information. Do not summarize what was just explained
• Avoid restating the title or introduction in the first paragraph

Common Mistakes - Scope

• Do not create a new page for a single concept, term, or procedure step

Common Mistakes - Accuracy

• Only include information you can ground in the existing codebase, linked documentation, or content already on the page
• Do not speculate or infer how a feature works
• Do not invent command syntax, API parameters, or UI element names

Screenshot Guidelines

• Resize wide or tall screenshots
• Compress size on disk to 100 KB or less
• Use descriptive lowercase filenames with underscores instead of hyphens
• Filenames should include the major and minor version of GitLab in the format _v18_6

Content Guidelines

• Avoid writing about the document itself; get straight to the point instead of using phrases like "This page shows"
• Do not promise work in future milestones; instead say work is being proposed
• Avoid blockquotes
• When linking to GitLab issues, include the GitLab issue number in the link text
• Start optional steps with "Optional."

Word List

• Follow the GitLab Documentation recommended word list for consistent terminology