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

Obsolete versions

Once upon a time, upgrading packages was just downloading and installing files. after a while, it also entailed compiling source code because my operating systems no longer received first-class support. Descent Into Madness after a while, upgrading a package also entailed upgrading the tools needed to make it and their dependencies. i felt like i had installed every (meta-)build system. on one of my MacBooks, Homebrew maintained two versions of Python and two versions of llvm . as projects migrated from Autotools to CMake, library versions became inconsistent. these inconsistencies puzzled me, because the first test one should perform after adding support for another build system is determining if the result is the same. any differences should be eliminated/explained. in real life, most people didn't ...

Cat's whiskers

Online forums are good sources of information and/or habitats for groupthink. Jean Valjean ignored the smell; so can you :-) forums are biased in various ways. for example, woodworkers' opinions about linseed oil are informed by wood finish products. in another forum, we might find a recommendation for finishing wood with linseed oil sold by an art supply store. sauce for the painter is sauce for the woodworker? Slippery when wet when i became interested in safety razors, forums were invaluable sources of information. they are still helpful, but i learned enough to continue on my own. at one point i bought cheap shaving soap thinking that it couldn't be as bad as forum contributors claimed. they were right, but the soap was/is still useful: it stays at th...