Are these abbreviations common in programming/image processing?

  • Thread starter Thread starter Jun Kyoto
  • Start date Start date
  • Tags Tags
    Processing
AI Thread Summary
The discussion centers on the use of abbreviations in user interfaces for image processing products, specifically evaluating their clarity and commonality. Participants express mixed feelings about various abbreviations, with some suggesting that terms like "Circle" should be spelled out or abbreviated to "Cir." or "Circ." for better understanding. The abbreviation "Inter." for intersection is criticized for failing to convey the concept of intersection effectively. Suggestions include using tooltips to provide full terms or descriptions when users hover over abbreviations, enhancing clarity.Examples of potential combinations of abbreviations are discussed, with some participants finding them awkward, particularly in sentences where context is crucial. The consensus leans towards minimizing abbreviations unless necessary due to space constraints in the UI, emphasizing that clarity should not be sacrificed for brevity. Overall, the conversation highlights the importance of user comprehension in technical writing and the need for clear communication in product interfaces.
Jun Kyoto
Messages
14
Reaction score
1
Are any of the following abbreviations common or do they rather make you confused when they are on an user interface of an image processing related product?Any other suggestions?

- Position-Pos.
- Coordinate - Coord.
- Radius - r
- Circle - CRCL/ Cir./ Circ./ Crcl
- Deviation - Dev.
- Region - Reg.
- Intersection - Inter.
- Reference - Ref.

Further, do they make sense in combinations as follows?
- Crcl pos x = Circle position x
- Ref.x = x coordinate of a reference point
- Upper left corner x of a square = x coordinate of the upper left corner of a square
-Inter.x = x coordinate of an intersection of few lines

NOTE:
*The product's instruction/UI are American English based.
**Some graphics, or other explanation might be provided to give the context, but not always.

Thank you in advance.
 
Technology news on Phys.org
Jun Kyoto said:
Are any of the following abbreviations common or do they rather make you confused when they are on an user interface of an image processing related product?Any other suggestions?

- Position-Pos.
- Coordinate - Coord.
- Radius - r
- Circle - CRCL/ Cir./ Circ./ Crcl
- Deviation - Dev.
- Region - Reg.
- Intersection - Inter.
- Reference - Ref.
I would spell out circle, but could live with Cir. or Circ.

Inter. for intersection is bad, IMO, because it doesn't capture the idea of things intersecting. The rest are OK, IMO.
Jun Kyoto said:
Further, do they make sense in combinations as follows?
- Crcl pos x = Circle position x
- Ref.x = x coordinate of a reference point
- Upper left corner x of a square = x coordinate of the upper left corner of a square
-Inter.x = x coordinate of an intersection of few lines

NOTE:
*The product's instruction/UI are American English based.
**Some graphics, or other explanation might be provided to give the context, but not always.

Thank you in advance.
 
Can you perhaps put the entire word or phrase, or even a brief description, in a tooltip that pops up when the user hovers the cursor over the abbreviation?
 
  • Like
Likes Medicol
@Mark44,
Thank you, your expertise really counts!

@itbell and other possible audience,
Here's some more specific examples:

-Set by angle and pos. (to mean "Set by angle and position")
-Measure ref. (to mean "Find the reference point")
-Ref. other image (to mean "Reference other image")
-Specify rgn. # (to mean "Specify a region number")

I look forward to more advice.
 
Jun Kyoto said:
@Mark44,
-Specify rgn. # (to mean "Specify a region number")
I definitely prefer your original reg. instead of rgn.
 
I would only abbreviate common words if I had to. Assuming you have to abbreviate, those seem as good as any (except 'r' is too short). You need some way for the user to verify them. When something doesn't work, a person gets desperate looking for the problem and starts to doubt his interpretation of abbreviations. The abbreviations are ok in variable names, where abbreviations are expected, but it seems awkward to abbreviate common words in a sentence like: " Enter the r in the window." Many of your examples in post #4 seem a little awkward to me.
 
If you are the intended audience and it is not readily clear to you, then it is bad technical writing.
 
.Scott said:
If you are the intended audience and it is not readily clear to you, then it is bad technical writing.
Or are you, @Jun Kyoto, the writer, and asking for us to review your work?

If that's the case, is there a good reason for all of the abbreviations, such as limited space in the UI? If there is no such constraint, I would not use abbreviations.
 
  • Like
Likes Lizabella and FactChecker
Thank you all, this has been very helpful. As @Mark44 assumed, space on the UI is limited and that is only why we are considering use of abbreviations.

Will use them within a clear context/clues at the least frequency.
 
Back
Top