The increasing need to produce online documentation and meet users’ needs with visual user interfaces is being met by a timely convergence of Web technologies. Scalable vector graphics (SVG) is part of HTML5 and has considerable potential for producing hyperlinked infographics for online help. Unlock that potential with the help of the live Web seminar Visualizing Documents With Scalable Vector Graphics, presented by David Gardiner on Tuesday, 29 July, from 10:00-11:00 AM EDT (GMT-4).
This webinar shows how SVG can be the basis for new document interfaces that integrate with topic-based help and improve the user experience. Documentation can be restructured for a visual-first interface to quickly familiarize users with concepts and procedures, and “quick link” to reference information. Learn how SVG as an enabling technology can be the basis for embedded video, translation/localization, and Web app documents.
Note: Be sure to check out David’s article in the July/August issue of Intercom as well, titled “Hypergraphics for Interactive Documents: Improving the User Experience with Scalable Vector Graphics.”
Guest Post by Bill Leavitt, Past President and Fellow
BILL COGGIN, STC Fellow and Student Advisor of the Bowling Green State University Student STC Chapter, passed away on 9 February 2014 after a long illness. Bill served the technical communication profession and STC both in the academic and professional/industrial arenas with significant personal and professional success.
Bill taught technical communication classes at Bowling Green State University (BGSU) and was instrumental in creating the BGSU English Department’s Technical and Scientific Communication program, which offered both Bachelor’s and Master’s degrees. Bill also created a large and successful student chapter at BGSU and served as its advisor and editor of the national students’ STC journal. To help his students with their job searches, he established a fund that helps students attend and present papers at STC international conferences; this fund will continue to help students for the foreseeable future. Bill was a very popular teacher and student chapter advisor and he did everything possible to help his students to successful careers.
At the Society level, Bill was elected Region 5 director-sponsor for the term 1986-1989 and was nominated for second vice president of STC in 1989 and 1990. During my administration (1989-1990), Bill was appointed to be the first person to serve in the newly created position of Assistant to the President for Academic Affairs, which was the principal contact for students and student chapters to be represented on the STC Board of Directors. In this position, he created an academic support role that has endured in one form or another for 25 years.
[click to continue…]
Being a technical writer and editor, I’m somewhat fond of style guides. The other day I found a good deal on the Associated Press Stylebook and Briefing on Media Law 2013, so I bought it and took it home. Flipping through the book later, I read this in the Foreword:
“The first Associated Press Stylebook was 60 pages, bound together with staples. It marks its 60th year as a comprehensive reference manual that fills more than 500 pages and is published across an array of digital platforms, encompassing the collective wisdom of its readers….”
There’s a subtle yet serious problem with the first pronoun and its antecedent. Before I explain it, here’s a refresher from 7th-grade English class.
Pronouns take the place of nouns. For example, in the sentence “She is so tall,” the pronoun “she” replaces the name of the person the speaker refers to. Pronouns save us work and make our speech more elegant. Without them, we’d have to repeat the name of the noun itself in every sentence we spoke about it.
Consider this sentence. “Karen just got here. You know, she is so tall. I wonder where she shops for dresses?” Without pronouns, we’d have to say “Karen just got here. You know, Karen is so tall. I wonder where Karen shops for dresses?” That’s ugly.
[click to continue…]
We often hear that something is “good enough.” I used to consider that phrase derogatory. In fact, working as often as I have within the government, I have always hated the phrase, “good enough for government work.” As a proud professional, I like to think that my work is error-free. I know most writing and editing rules and I try to follow them, yet sometimes, mistakes happen! As a new technical communicator, I had little flex about what was right and what was wrong. Back then, I had the luxury of working in a job where my talents were appreciated and the company didn’t focus on next quarter’s share prices. Combine that environment with my brand-new, college-degreed book-learning, and my only choice was to strive for perfection.
Fast forward. Today, after many years of being a technical editor, doc manager, and project manager at a for-profit company, I learned that striving for perfection is foolish. Perfection costs more than it’s worth and it’s unattainable.
One of the classes I teach is in basic technical editing techniques. My students edit various documents and, of course, not one of them can exactly reproduce in their exercises what I provide in the answer key. Why? Because writing and editing are not exact sciences. I tell my students that their primary objectives are to fix errors and avoid making new ones. If they can do that, they succeed. Sure, some students edit “better” than others do. Their sentences are shorter; their words more concrete. Their final versions better meet the needs of the audience and purpose. Yet, as long as a student follows those primary objectives, I’m happy.
[click to continue…]
Guest Post by Bill Leavitt
A few months after I became STC president, I was invited to visit the Toronto Chapter to discuss with them an issue regarding education of technical communicators. I arranged a visit in December 1989, and invited my newly appointed Assistant to the President for Academic Affairs, Bill Coggin, to go with me.
We were not warmly welcomed to say the least. We discovered that the North American Free Trade Agreement (NAFTA)* was going to create a problem for Canadian technical communicators. Apparently the politicians who crafted the agreement couldn’t easily define “technical communicator,” so they simply said that technical writers or technical communicators could work in other NAFTA countries if they had a baccalaureate degree in technical communication. As technical communicators, most of us know that not all technical communicators have a degree or education in this subject. In fact, probably significantly less than half of all practicing technical communicators had a degree in this field at that time.
My research showed that over 100 U.S. universities offered programs in technical communication, but only one Canadian university (at that time) offered an acceptable program. So, while possibly one-quarter to one-half of the technical communicators in the United States had degrees that met the requirements, and thus could do consulting work in Canada, no universities in Canada offered technical communication programs that met the NAFTA requirements, and thus, could not consult in the United States.
[click to continue…]
I work on a small project team that has just enough people to keep the project somewhat on schedule. When the quality assurance manager asked for help to test software—I volunteered. My manager was delighted and disappointed that I volunteered to test software because he believed that testing software would take me away from my primary job—writing a user guide. As it turned out, testing software helped me to learn the system’s workflows and logic, which helped me to write the user guide.
While testing the software I found opportunities to put my technical writing skills to good use. While referring to test cases to evaluate the software, I rewrote test cases that did not have clear and complete instructions. I created reports to identify errors to workflows, labels of buttons, and messages.
You might believe that correcting test cases is not your job and you are correct. It’s not your job to test software. I am not advocating that you work outside your job description. However, if test cases are your only source for understanding the navigation of the system then you might want to volunteer to rewrite them. On the other hand, you can always rely on the helpful and friendly developers.
Technical writers know the importance of getting the software correct to avoid their user guide (and training) to become a solution for poor design. Involving technical writers in the testing process brings the perspective of the end user. Bringing the perspective of the end user to the design effort ensures that designing a satisfying user experience is as just as important as meeting the release deadline.
Working outside your job description and raising your visibility above the expectations of coworkers will elevate you to new heights and put your skills to good use—helping to design the user experience.
I’m David Dick and I’m Talking Usability
More and more communities and community members are taking advantage of the renewed mailing lists. We noticed that the Consulting and Independent Contracting SIG, in particular, was making great use of their mailing lists. We asked the SIG Manager Marilyn Woelk to share what they’ve done to help spur interest and conversation. See her guest blog below. If you are a Chapter or SIG member and are contacted by your community leader to register for a list, please do so. You can also sign up for mailing lists online.
The technical communication profession can be full of challenges; it’s up to you to learn how to solve them. If you are having a software issue, don’t you want to ask someone about it? Wouldn’t it be nice to know how to respond to a client that is bending your contract to the breaking point? Would you like to know how to market yourself and your services more effectively? Yes, we would, too! By “we,” I mean the over 400 members of the STC Consulting and Independent Contracting (CIC) SIG. The CIC SIG has seen a need for these kinds of discussions for many years and has had a very active discussion list. Since we now have a new list provider (and a new address for our discussion list), we thought it was time to reintroduce the list and get some interesting new discussions started. We developed a process for re-engaging our members.
First, Tracy Parkin (our acting Membership Manager) enrolled all members of our SIG in the new list and gave them the option to opt out if they chose to do so. Next, Ann Wiley (List Manager) invited all of the list subscribers to introduce themselves, explain how they got into the field of technical communication, and describe the services they offer. Finally, we added “fuel” to the current list discussions by posting a few interesting questions about how to convert documents into e-books, what the contract industry is like now, etc. We allowed members to post back and forth about specific questions. (They did this by listing the topic they were responding to in the subject line of their emails to the List Manager.)
[click to continue…]