Skip to main content

Improper english

Before retirement ended my last spell of unemployment, i wondered if the timing of that dismissal was ideal. one month earlier or later might have been better?

improving a server log was my last assignment. like many other companies, their senior management believed in their culture, technology, and tools. like other well-funded companies, they used Splunk and wanted to use JSON format. nobody reviewed the pull request that would have established a baseline for my work. their Splunk dashboard code was not versioned.

Overcommunicating

JSON can be ideal, and creating a data structure to discover if a log entry describes an error is easy and reasonably fast, but computers find strings very quickly. a faster algorithm uses less electricity; computer activity is human activity.

a new JSON object member doesn't interfere with older ones. this encapsulation is good, but it leads to interface bloat. for example, my supermarket's product representations contain descriptions like:

  • vitamin A; calculated by summation of the vitamin A activities of retinol and the active carotenoids

this text is actually part of the minimum viable details for a product.

Subtle consistency

continuing my rant about logging, a log should support finding information with grep or something comparable. it should look like it was written by a machine.

the log's dialect should be natural language augmented by jargon introduced by customers and product owners. the log should not mention implementation details like source code line numbers and thread identifiers, because such references make it harder to analyze failures by comparing logs generated at different times.

consistent language usage facilitates filtering/searching log entries, while natural language usage makes this consistency less stilted.

Prolix torture

precise language usage facilitates communication between team members with different linguistic backgrounds. synonyms may seem harmless to people who are fluent, but team members change and outsourcing is common. when two words have similar definitions, review their connotations to see if one is more appropriate. when all else fails, use the shorter word (which probably has fewer syllables).

it should be possible to analyze texts to discover the history of our (collective) affection for jargon. i assumed it was a side effect of technology infiltrating everyday life, but now i'm not sure.

during rush hour in a large city, sometimes someone would try to squeeze into my train, the door wouldn't close, and our departure would be delayed. to avoid this delay, the operator would tell people on the platform: We have an immediate follower. that rarely had the desired effect, so some operators would say:

  • We have an immediate follower behind us.

as Pogo famously said: We have met the enemy and he is us.

Comments

Popular posts from this blog

Open sesame

Indian food dominated my diet while i lived near a small restaurant staffed by its owner and at most one assistant. the leftover food was featured in at least two meals after my weekly visit. my habit of dining at this restaurant influenced my vacation schedule. at first, the menu included rarities like fish smothered by a very spicy green curry and house-made lemon achar . (the curry was thicker than Hilda's .) after a while, various shortcuts were taken. house-made achar was replaced by store-bought and several favorites became historic, but i remained faithful. i ate there about 700 times before moving away. Pickle jar one evening, the assistant accosted me with a jar of achar and indicated that i should open it for him. so i did. ...

Salt cod

Twas brillig and the slivy toves ... words that might be apt before a hiatus. one of this blog's goals is introducing a Holistic software development protocol. i could upload a medium-size example of an application that illustrates the protocol's benefits, but want to present a smaller example. unforunately, that project needs a restart. so this is another post about food . General store old movies introduced me to the department store's precursor. i was lucky to live near one in a Portuguese neighborhood. one day, i saw spools of cotton seine twine casually displayed in a shopping cart. (nobody used shopping carts there; the store was too small.) the smallest spool was quite large, but i bought it anyway because its quality was so high (four-stage construction). ...