Select a backup style guide for documentation
While the GitLab style guide is extensive, it doesn't cover all use cases. Example: gitlab#207941 (closed)
To save time, I think it'd help to pick some other major style guide, for "any questions not covered by our GitLab documentation style guide"
Otherwise, we're committing to spending time on debates whenever we have issues like this. Fortunately, we do not have to "reinvent the wheel", as there are at least two extensive software documentation style guides available:
- Microsoft: https://docs.microsoft.com/en-us/style-guide/welcome/
- Google: https://developers.google.com/style?hl=vi
In many cases, we may look at these bigger style guides and say "No, we want something else", and that's great. However, I think picking some bigger style guide "for everything else" would save us time.
But we need to choose that other major style guide. It'd help if that guide fits our preferences as a team. To that end, when we as the TW team have style issues not covered by our current style guide, we'll
- Examine the other noted software documentation style guides
- Record our choice/preference in this spreadsheet
After we get to a reasonable number of entries (10?) in the spreadsheet, see if there's a "clear winner" for preferred backup style guide.