GitLab Duo Feature Name Localization and Styleguide Update
Objective
This issue aims to provide comprehensive context to linguists and the localization vendors regarding terminology and technical writing decisions for GitLab Duo capitalization and usage, as well as feature naming capitalization. The goal is to align our approach, document our process for feature naming, and consolidate any necessary term changes.
Current Guidelines on Gitlab Duo usage (English)
As stated in the GitLab Duo documentation:
- Always use "GitLab Duo", never "Duo" by itself.
- On first use on a page, use "GitLab Duo ".
- After the first use, use the feature name without "GitLab Duo".
- How to talk about Gitlab Duo, as per our Word List docs page.
Current Guidelines on capitalization
While as a company, we tend toward lowercase.
Feature names
Feature names should be lowercase.
However, in a few rare cases, features can be title case. These exceptions are:
- Added as a proper name to markdownlint, so they can be consistently applied across all documentation.
- Added to the word list.
GitLab Duo Feature List
- GitLab Duo AI Impact Dashboard
- GitLab Duo Chat
- GitLab Duo Code Explanation
- GitLab Duo Code Review Summary
- GitLab Duo Code Suggestions
- GitLab Duo Issue Description Generation
- GitLab Duo Issue Discussion Summary
- GitLab Duo Merge Commit Message Generation
- GitLab Duo Merge Request Summary
- GitLab Duo Product Analytics
- GitLab Duo Root Cause Analysis
- GitLab Duo Test Generation
- GitLab Duo Vulnerability Explanation
- GitLab Duo Vulnerability Resolution
- GitLab Duo Enterprise
- GitLab Duo Pro
- GitLab Duo Workflow
Action Items
- Review and confirm the capitalization and naming conventions for all GitLab Duo features listed above in all our 6 locales.
- Identify any terms that require translation updates.
- Ensure all target files in production are updated with any term changes.
- Draft a new section for the styleguide providing guidance on GitLab Duo feature naming and usage.
- Document the process for feature naming in general, with specific focus on GitLab Duo features.
Next Steps
- Review and discuss the proposed guidelines and feature list. Please provide feedback on any challenges or inconsistencies you encounter with the current naming conventions.
- Considering adding a new styleguide section on GitLab Duo feature naming and/or feature capitalization.
- Implement any agreed-upon changes to terminology or translations.
FYI @opysaryuk @maudl-ext @nakiyama-ext @djsulliv @muchikawa
Edited by Maria Jose Salmeron Ibáñez