WritingStyleGuide icon indicating copy to clipboard operation
WritingStyleGuide copied to clipboard

Provide guidelines for documenting object names

Open daobrien opened this issue 4 years ago • 13 comments

This discussion started around the use "application streams" vs "AppStreams" and "ApplicationStreams" but extends to other objects and concepts such as "deployment configuration" and "DeploymentConfig."

This issue requires discussion and agreement by SMEs from various practices.
When such agreement occurs I can add it to the relevant section of the guide.

Note: I use the term "object names" somewhat loosely because not all applications use the same terminology. Sometimes they are called resources, sometimes other things. Feel free to add more examples (e.g., BuildConfig) to help clarify this.

We need to answer several questions:

  1. When can we abbreviate and when not?
  2. When must we capitalize and when not?
  3. Which DocBook or other tags should we use, and when?

daobrien avatar Jan 14 '21 01:01 daobrien