This article is a continuation of my series on crafting clear technical announcements.
If you missed Part I, you can catch up here .
Part III is available via this link .
In this installment, we will dive deeper into another 2 essential rules that help platform engineers communicate more effectively with their teams and stakeholders.
Rule 3: Reduce “There Is/There Are” Usage
Developers love using ‘There is/There are’ in their sentences when referring to issues, learnings, or just about everything.
These phrases often lead to passive sentence constructions, which can dilute the directness and power of your communication. For instance, instead of saying:
There is an overlap between implementations of module A and module B,
you can make the statement more active and engaging by saying:
Implementation of modules A and B overlap a lot.
This not only tightens the language but also enhances the urgency and importance of the message.
By avoiding these phrases, you shift the focus directly onto the subject and action, making your sentences more dynamic and straightforward.
Rule 4: Reduce Usage Of Adjectives And Adverbs
Adjectives and adverbs can introduce subjective interpretations and unnecessary noise, complicating the reader’s understanding.
While these descriptive words enhance fiction and poetry, they tend to clutter technical documents, detracting from the main points. For example, instead of saying:
The server extremely quickly processes data,
it’s more straightforward and professional to state:
The server processes data rapidly.
Their overuse can give technical content a promotional tone, which may not be appropriate and could undermine the document’s objective nature.
By focusing on straightforward, actionable language free of of excess decoration, you ensure that your technical announcements are precise, professional, and tailored to effectively communicate with a technical audience.