Original link: https://www.hwchiu.com/read-notes-55.html
Title: “How to Write Meaningful Discussion Messages”
Category: others
Link: https://conventionalcomments.org/
This article is very short, the main idea is to discuss how to make these messages more meaningful when discussing matters through words, so that the target audience can understand the meaning of the message faster. If someone today wants to reflect the concept of “This is not worded correctly.” , the author believes that rather than directly writing “This text is improperly worded”, it is appropriate to add some pre-defined prefix adjectives such as “suggestion: This is not worded correctly.
Can we change this to match the wording of the marketing page?”
“nitpick (non-blocking): This is not worded correctly.”
Through these consensus adjectives, communication between teams can be made faster, the possibility of misunderstanding and guesswork is reduced, and the overall communication efficiency is higher, such as “suggestion: Let’s avoid using this specific function…
If we reference much of a function marked Deprecated, it is almost certain to disagree with us, sooner or later.”
“issue (ux, non-blocking): These buttons should be red, but let’s handle this in a follow-up.”
Using these adjectives can remind the target audience of some concepts to discuss, and also give them a better idea of what to do next.
The author lists several of the following prefix adjectives on his own habits
- Praise: to praise the item positively
- Nitpick: Most of them are small issues that are very small and do not affect the overall function, such as personal preferences and other related discussions
- Suggestion: There is an area of improvement for the current goal, and the point is to clearly and clearly describe what the problem is and why the improvement is needed.
- Issue: Emphasizes potential problems under the current topic. If it is determined that the problem already exists, describe it with Suggestion. Otherwise, it can be used with Question to confirm whether the problem exists.
- Todo: For simple and unnecessary modifications, the main purpose is to allow the audience to distinguish the importance of these discussions and to focus on the more important issues at the moment
- Question: If you have some uncertain questions about the current topic, use Question to let others know that you have a question to ask, which can help you get an answer faster.
After all, this type of discussion is a habit. Just like coding style, all co-workers have a consensus principle. It will be more efficient and convenient for everyone to cooperate. The method mentioned in the article is not the only way, but there is a rule within the team. Culture will definitely bring benefits
personal information
I currently have Kubernetes-related courses on the Hiskio platform. Interested people are welcome to refer and share, which contains my various ideas about Kubernetes from the bottom to the actual combat.
For details, please refer to the online course details: https://course.hwchiu.com/
In addition, please click like to join my personal fan page, which will regularly share various articles, some are translated articles, and some are original articles, mainly focusing on the CNCF field
https://www.facebook.com/technologynoteniu
If you use Telegram, you can also subscribe to the following channels, where I will regularly push notifications of various articles
https://t.me/technologynote
Your donation will give me the motivation to grow my article
This article is reprinted from: https://www.hwchiu.com/read-notes-55.html
This site is for inclusion only, and the copyright belongs to the original author.