Add recommendation for job-type names to best practices

[berndruecker]

• Run an internal poll/feedback gathering on ask-documentation, ask-devrel, ask-consulting, etc. to determine what is the most used or preferred casing for job-type (or any id really): kebab-case, PascalCase (upper case first letter), camelCase, snake_case, or something else. Note - this may be driven by programming language, in which case we may have recommendations for each priority language - Java/Spring, NodeJS, and .NET/C#.
• Add section to recommend names and casing in https://docs.camunda.io/docs/components/best-practices/modeling/naming-technically-relevant-ids/

[berndruecker]

@falko Do we already have an idea what the best practice is?

[falko]

I tend to use kebab case, e.g. my-service, and I don't call it worker. Instead I refer to the service or service operation.

[akeller]

Instead I refer to the service or service operation.

I like this for SEO on worker docs. If you commit to kebab case, please work with @christinaausley to add it to the style guide and update the guides content, if necessary, as well.

[berndruecker]

Just to get that: you (@akeller) would like to see this best practice to improve SEO for the docs? So you vote to raise prior for it - correct?

And then if we have added it we should stick to it (step 2).

[falko]

Another option would be to use method name style of your target programming language, e.g. camel case for Java 🐫. This would mean some variation across projects but could increase familiarity for developers, as a worker is often implemented as a method which could then have the same name. One could even derive the job type from the method name dynamically to make the code more DRY

[akeller]

I have no opinion on the casing or naming best practices other than when we decide on one let's update the rest of the docs to reflect our commitment to that recommendation.

From an SEO standpoint, I was curious if developers know what a job worker or worker is or if they have other terms for it. Based on Falko's response, it sounds like he refers to them as service or service operation. This is an easy add to incorporate these terms into the metadata but still continue to call it a job worker.

[akeller]

@christinaausley interesting topic re: job type naming. I didn't see this in the Writing Style Guide or the cheatsheet, but this is a great topic to sync with Product Marketing on, too, as they write or review technical content so everyone is consistent.

In the sample pages, I opened in the Guides section, every value in the Type field was kebab-case (spaces-are-replaced-with-dashes). However, in the Best Practices section, I see ~CamelCase~ PascalCase (camelCase would have the first letter lowercased).

I'm going to move this to the DevEx Board and update the description.