Posts

Showing posts with the label technical communication

Reminiscences: software documentation

Image
I feel fortunate that I can't identify first-hand with Tina, the long-suffering tech writer in Dilbert. My desire to provide user and administrator manuals for software applications stem back to even before I entered the professional workforce. The motivations, however, didn't stem from any false hopes that there would be any significant audience for said work. As an undergraduate I eventually ended up majoring in a combination of Technical Communication and what they call Brain & Cognitive Science, which involved neuroscience, psychology and linguistics. I also worked at the university libraries, where I spent one summer cataloguing musical recordings by the various ensembles over several decades (mainly on vinyl). It was the following year, that their adoption of a system from OCLC (I believe it was Connexion, but I could be mistaken) led to an opportunity to create an administrators' concise guide. When later I arrived at a documentation role, I found that str

Balancing diction (quality) and comprehensibility (effectiveness)

Image
Something which by now may have become apparent to my colleagues and friends alike, is that in personal writing I gravitate toward long and complicated sentences. The formality of my writing has also been remarked upon by more than one friend. On the other hand, I also try to optimize diction: that is, I have an old habit of attempting to use whatever word I believe is most appropriate, regardless of how rarely one might hear it. In my Japanese language post from May, I had mentioned that I experience a constant struggle to maintain linguistic competence. In fact, it seems self evident that disuse leads to atrophy in many situations, be they physical (musculature), neural (pathways to access memories) or otherwise. With tweeting, the stringent limit on message length means I struggle with the inevitable prevalence of abbreviations and  (in that case, &) initialisms - and rarely, acronyms - far more in English than I do in Japanese. However, in the latter tongue I clearly need