StyleGuides / WritingStyleGuide

The official Red Hat guide to writing clear, concise, and consistent technical documentation.
Creative Commons Attribution Share Alike 4.0 International
73 stars 20 forks source link

Add usage for "named" versus "called" #588

Closed julian-cable closed 4 months ago

julian-cable commented 5 months ago

From David O'Brien and Sam Ffrench:

When referring to the designation of files, objects, or entities within documentation, prefer the term "named" instead of "called." This choice promotes clarity and precision in our technical communication. The word "named" directly associates the name with the entity and is more specific in technical contexts. "Called" can imply a more casual or informal reference and may introduce ambiguity, because it can also mean "invoked" in the context of functions or methods. For example: When you need to store configuration settings, create a directory named configurations to keep your workspace organized.

Examples of when to use "named": file named, directory named, task named, user named, group named

By contrast, "called" would be used specifically when referring to programs, scripts, or code in general calling (i.e., invoking) functions. Other than that there might be cases where "called" is a proper noun, part of a UI, etc.; all those normal cases where we can't change what we might otherwise like to.