TechWhirl: Technical Communications Recap for February 17, 2012

[INKtopia Admin <admin -at- inktopia -dot- net>]

This week’s update on technical communications and the TechWhirl community
is supported by Platinum sponsor Madcap & their Ultimate Communications
Suite, MadPak <http://goo.gl/eO3ls> |  http://bit.ly/zBI0Uj
>From the Desk of the Editor

Back at the turn of the century, the TechWhirl discussion list was
embroiled in a vehement debate on content versus structure (called “structure
versus substance <http://www.techwr-l.com/archives/0006/index.html#00483>”)…
and I mean vehement. There were those on the SGML bandwagon (see, I told
you it was turn of the century) who believed nothing was more important
than structuring the content correctly.  And then there were those of us
who wondered what the point of well-structured content was if it didn’t say
anything important, relevant or coherent. I remembered quite clearly trying
to argue that for technical communications, one can’t survive without the
other. At that time I was a content-first hothead, but I’ve always
understood that structure provides the context that allows meaning to be
conveyed.  (Those outlining exercises from my third-grade teacher Mrs.
Beagen, and subsequent years of sentence diagramming did indeed pay off).



Now fast forward to 2012, and like so many of our technical communications
debates, the attributes have changed, but the core principle remains…
content and structure are intimately and forever entwined.  This symbiotic
relationship was clarified for both Al and me over the weekend when we
reorganized the TechWhirl website with a new taxonomy.  An 18-hour marathon
that resulted in a more usable and sustainable organization for the great
content being produced by the Special Writers
Unit<http://techwhirl.com/about-techwhirl/swu/>,
guest contributors and others in the field who comment here and on the list
with great insights.



Prior to Sunday’s marathon, we’d spent many hours in the realm of taxonomy
trying to determine the best way to organize our content to be findable.
Taxonomy is tough, but slogging through the process gave me a great
appreciation for the other structure-related tasks—like developing schemas
or DITA templates—that are required to produce useful, usable stuff for our
customers.  We didn’t mess with design, and we sure didn’t mess with
content, but we hope you’ll find your way around Techwhirl.com a more
pleasurable and productive excursion.



While you’re sightseeing, stop for a moment and take a look at Jacquie
Samuels’ Tips and Tricks for Video
Tutorials<http://techwhirl.com/skills/delivery/technical-writer-tips-tricks-video-tutorials/>,
and take a break to laugh at another turn-of-the-century classic on the
unemployment fairy and
karma<http://techwhirl.com/technical-writing-humor/technical-writing-humor-the-unemployment-fairy-and-karma/>from
Lisa Higgins.



Video tutorials or the unemployment fairy not your true technical
communications love?  That’s okay, slide over to our weekly poll and tell
us about your undying love for all things tech
comm<http://techwhirl.com/business/polls/technical-writer-poll-profess-your-love-for-all-things-tech-comm/>in
our weekly poll.  Because we know, like structure and content, the
ones
we love have different outlooks and purpose, but they’re always bound
together with us.





Have a great weekend!

- The gang at TechWhirl


In Case You Missed it: This Week  @ TechWhirl

*New on http://TechWhirl.com <http://techwhirl.com/>**: *


   - Classic Technical Writing Humor: The Unemployment Fairy and Karma, by
   Lisa Higgins | http://bit.ly/zXmZet
   - Technical Writer Tips & Tricks: Video Tutorials, by Jacquie Samuels |
   http://bit.ly/xdzGmo
   - TechWhirl Poll:  Profess Your Love for All Things Tech Comm |
   http://bit.ly/yeq6Vq



*Tech Comm News: *


   - Tech Writer This Week: February 16, 2012 | http://bit.ly/xkdJpL
   - Bluestream Releases XDocs v3.1 DITA-enabled Doc Solutions |
   http://bit.ly/xv7Svd
   - Digital Media Provider Aptara Announces Acquisition by iEnergizer
   Limited | http://bit.ly/AlIxYG
   - Net-Translators Introduces Mini-Site Translation Package |
   http://bit.ly/AzjjZq
   - STC-Montreal Members Vote to Sever Ties with Society for Technical
   Communication | http://bit.ly/xDJ3Za

Technical Communications: What You’re Talking About

A quick *shout out* to our Technical Writers and their discussions in our email
discussion group <http://goo.gl/YUrbb>:


   - Kevin McLaughlin struggles with conveying the correct meaning of
   command-line syntax so he asked the list “How you say... ?” and included
   three options.  Whirlers responded with their knowledge of standards for
   command-line syntax and recommendations to remove ambiguity.
   - Mark Eichelberger is looking for opinions on a “Generic MS Windows
   Support message” for his documentation, one that clearly indicates support
   (or lack thereof) for OS versions. Whirlers focused on software
   documentation responded with good alternatives on how or whether to include
   service pack information, whether to list each OS version, and more. Julie
   Stickler recommended surveying tech support and sales to find out if
   customers or prospects ask for specific OS support.


*Social Media and the Chance to Follow TechWhirl:*

   - Our Google Plus Page – what’s happening behind the scenes |
   http://goo.gl/SO0R4
   - Will you be our Friend? Please, you know you want to click |
   http://goo.gl/tDrW7
   - Want all this TechWhirl goodness a few characters @ a time |
   http://goo.gl/itjDg
   - Updates from TechWhirl delivered to your email in box |
   http://bit.ly/tjshxU
   - Or, try our RSS feed (great on Flipboard) | http://goo.gl/msLzu

SPONSOR-Luv

We want to send a very special “thank you” to our sponsors for their
support.



*Platinum*: Adobe Systems
Incorporated<http://www.runaware.com/clients/adobe/techsuite/>

*Gold: *ComponentOne
Software<http://www.doctohelp.com/?utm_source=techwrl.com&utm_medium=125x125%2Bbanner%2Bad&utm_campaign=doctohelp>
,* *Madcap Software<http://www.madcapsoftware.com/products/flare/overview.aspx#whatsnew>
**

*Silver*: Society for Technical Communication (STC)
<http://www.stc.org/>, Vancouver
Island University <http://pr.viu.ca/techcomm/>

-- 


TechWhirl.com
Online Magazine and Discussions for Today's Tech Writer

Follow TechWhirl on
Twitter:         @TechWriterToday
Facebook:     facebook.com/techwriterlist
Google+:     plus.ly/TechWhirl
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Create and publish documentation through multiple channels with Doc-To-Help.
Choose your authoring formats and get any output you may need.

Try Doc-To-Help, now with MS SharePoint integration, free for 30-days.

http://bit.ly/doc-to-help

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot- 

To unsubscribe send a blank email to
techwr-l-leave -at- lists -dot- techwr-l -dot- com


Send administrative questions to admin -at- techwr-l -dot- com -dot-  Visit
http://www.techwhirl.com/email-discussion-groups/ for more resources and info.

Looking for articles on Technical Communications?  Head over to our online magazine at http://techwhirl.com

Looking for the archived Techwr-l email discussions?  Search our public email archives @ http://techwr-l.com/archives