• 0 Posts
  • 691 Comments
Joined 3 years ago
cake
Cake day: June 22nd, 2023

help-circle


  • Outside of the for loop counters i and j, short variable names are awful. Coming back to old code written with abr var nams is like talking to someone in the military who just constantly throws out jargon and acronyms that they know you don’t know.

    But so are Java style ObserverFactoryManagerTemplateMachinistTemplater names.

    There’s a sweet middle ground of short, but actually descriptive name. Sometimes it’s not possible but that’s usually a code organization / language / framework smell.

    Too short variable names is usually a sign that you need to use a proper ide, with auto complete, or that you need to use a proper build process that will minify your code after the fact.

    Too long names are usually a sign that your module of code (function, class, namespace, etc) is too large, or that your language/framework naming conventions are too strict, or the language doesn’t encapsulate scope properly.












  • I agree with everything you’re saying, but even speaking specialist to specialist, or say to a group of specialist colleagues who might not be working on exactly what you’re working on, you still often simplify away the technical parts that aren’t relevant to the specific conversation you’re having, and use specific language on the parts that are, because that inherently helps the listener to focus on the technical aspects you want them to focus on.


  • If you’re communicating with another scientist about the actual work you’re doing then sure there are times when you need to be specific.

    If you’re publishing official documentation on something or writing contracts, then yes, you also need to be extremely speciific.

    But if you’re just providing a description of your work to a non-specialist then no, there’s always a way of simplifying it for the appropriate context. Same thing goes for most of specialist to specialist communication. There are specific sentences and times you use the precision to distinguish between two different things, but if you insist on always speaking in maximum precision and accuracy then it is simply poor communication skills where you are over providing unnecessary detail that detracts from the actual point you’re trying to convey.





  • Eh I don’t really agree, depending on how simple you’re talking. Bags within bags, or dumbing things down to a grade school level, then sure, there are topics that can’t be described succinctly.

    But if you’re talking about simplifying things down to the point that anyone who took a bit of undergrad math/science can understand, then pretty much everything can be described in simple and easy to understand ways.

    Don’t get me wrong, I’ve seen many people at the top who can’t, but in every case, it’s not because of the topics’ inherent complexity, but either because they don’t actually understand the topics as well as they may seem, or because they lack the social skills (or time / effort / setting) to properly analogize and adjust for the listener.