SUSE / doc-styleguide

SUSE Documentation Style Guide
https://susedoc.github.io/doc-styleguide/main/html/style-guide/
Other
14 stars 2 forks source link

Product names - their spelling and no article before #246

Closed dariavladykina closed 6 months ago

dariavladykina commented 1 year ago

In this chapter of DSG, we state that:

The correct spelling of SUSE product names should be listed in the terminology table (Appendix A, Terminology and general vocabulary) and in the entities file of the Doc Kit repository at https://github.com/openSUSE/doc-kit/blob/main/docbook5-book/xml/generic-entities.ent. If a product name is not listed in either spot, refer to the SUSE home page, https://www.suse.com/ and the Marketing department.

First, Appendix A contains only SLES and basically no other product names. Second, the Doc Kit repo - does it contain all we need? Third, let's amend this paragraph and direct the users to the resource where they can find all product names. Is there one? Is it Doc Kit repo? The SUSE Style and Writers Guide does not feature ALP, for example, and I'm not 100% sure it doesn't lack sth else. Fourth, we should clearly indicate that there must be no article before product names. I suggest adding this to the same paragraph.

PadraigDillon1 commented 1 year ago

I found these two resources of product lists - https://www.suse.com/products/ (this lists all products in each BU and https://www.suse.com/products/terms_and_conditions.pdf - Exhibit A – Matrix of SUSE Products. Not sure how up to date the T&C list is but it is extensive.

cwickert commented 1 year ago

First, Appendix A contains only SLES and basically no other product names. Second, the Doc Kit repo - does it contain all we need?

It should contain have all we need (if we lack something, we add it), but I'm not sure it's 100% accurate when it comes to Capitalization, Acronyms etc.

Third, let's amend this paragraph and direct the users to the resource where they can find all product names.

+1

Is there one? Is it Doc Kit repo?

We cannot use DocKit authoritative source. The official list needs to be maintained by marketing.

The SUSE Style and Writers Guide does not feature ALP, for example, and I'm not 100% sure it doesn't lack sth else.

But it seems to be the best we have right now. Let's rather fix this (ask them to include missing names) instead of starting something new.

Fourth, we should clearly indicate that there must be no article before product names. I suggest adding this to the same paragraph.

+1

dariavladykina commented 1 year ago

Also reference TermWeb as a source of information (check the correct URL to list in DSG). Add https://www.suse.com/products/ and Marketing as POC. Add guidance: Don't use any internal code names - check for official product names first and if unsure, check with Legal.

jfaltenbacher commented 1 year ago

actually the plan is to list all product names in TermWeb and have them approved by PM or alike. Various product names have been added already but still miss approval