08/18/08
Upcoming conferences...
Q3 2008 is jam-packed with conferences that cover a variety of technical communication topics. Note that in some cases, the registration deadlines are coming soon!
- UA Conference - Europe 2008. 18 to 19 September 2008 in Edinburgh, Scotland. Produced by Matthew Ellison Consulting in association with WritersUA, this two-day conference includes topics about language, tools and methodologies, wikis, portals, and more.
- DocTrain EAST. 29 October to 1 November 2008 in Burlington, Mass, USA. This four-day conference, produced by Pubsnet, includes pre- and post-conference workshops that are included in the registration price. Topics include instructions on specific tool functionality and information on project management, content convergence, XML, and more.
- tcworld conference. 5 to 7 November 2008 in Wiesbaden, Germany. Produced by tekom, this conference draws the largest number of technical communicators. Topics include processes, localization and translation, tool instruction, XML, and much more.
- LavaCon, run by Jack Molisani in conjunction with Project Management Institute. 6-8 November 2008 in Honolulu, Hawaii, US. LavaCon includes proven best practices in the fields of technical communication and project management, presented in tracks. Topics include conflict resolution, XML and DITA, localization and translation, and more.
Good luck choosing :-)
08/13/08
Michael Hughes explains why he hates PDFs...
Do you know (or know of) Michael Hughes? If you don't, you should. Mike has all sorts of credentials (if that matters to you)...he also has a wealth of knowledge about usability and writes a column for UXmatters.
And he just wrote a blog post (that I wished I'd written) about how he hates online user manuals that are distributed as PDFs, especially those that are formatted for printing.
If you're going to distribute an online PDF as a user's manual instead of one of the many appropriate online formats, then at least make it easy for your users. Follow Mike's tips: set them up for simplex printing, not duplex. Make the page numbers match up so that page 100 in the PDF uses 100 as the page number that's displayed. Get rid of the "book" overhead like front and back covers.
In addition, I'd add a few more:
- Don't use independent chapter numbering (where each chapter restarts from 1), unless your goal is to frustrate your users beyond belief. (Picture this: you open a PDF that's 300 pages long. You want to read the information in the last chapter before the appendices, which starts on page 6-1. As you look at the vertical scroll bar in the window, where do you think you should scroll to to find page 6-1? To the middle, maybe? To the end? What page number should you go to? Will you find 6-1 on page 100 of the PDF? Page 200? Page 295? Think of how much easier it would be to search for page 200 in a 300-page PDF, especially if page 200 is really the 200th page.)
- Forget "picture-perfect" layouts. I don't mean that you should not care at all, but if your company isn't going to be printing these PDFs for your customers, then relax your standards a little. Don't require that every page element is perfectly placed. If you're not careful, you'll spend more time fixing layout issues and using up the budget before the content is finalized.
- Put the "important but not a priority" stuff at the back. For example, copyright doesn't have to be at the front. Yes, copyright is important (see some of my other posts). But if a user is opening the PDF, it's typically not to read your copyright...it's to find the answer to a question. It's already a harder process than it needs to be because it's a PDF...moving this kind of content to the back makes it easier for the user.
(BTW, I find Mike very credible, even if he does provide quotes from The Gladiator. ;-))
08/12/08
What's a topic?
Back in 1998, I defined topics as "'chunks' of information in a Help file that answer one question or provide focused, specific content." Ten years later, I typically use the same definition. However, there have been some changes in how those "chunks" are developed.
In the beginning, we mostly used Microsoft Word to create topics, where codes or styles in the doc file divided the output into topics. One topic in the Word file became one topic in the output. With the advent of HTML Help, we moved to HTML files, and what we saw in development was what we saw in the output. The best we could for reuse was using a topic in more than one place in the table of contents.
This was because most of us used file-based tools. But now we have more features. For example, snippets are included (or embedded) in the core topic. Variables let us define reusable bits of content (and sometimes we can override them when publishing). Build tags, conditional tags, and variants let us choose which topics are published. And when we publish, the file that we created in development becomes the file that is used for the output. (One exception would be those using Word for WinHelp, HTML, or HTML Help...but again, the topic that is defined in Word becomes the output topic.)
With XML, however, things are a little different. Topics in development may only be part of the topic that is published. For example, a topic may reference another topic. In development, you see the reference, and in the output, you see the topic.
And with XML and database tools, there's another level of differences. Topics are organized with maps or tables of contents. Different settings control if the individual topics in development will become individual topics in the output or if multiple topics in development will be merged to create only one topic in the output.
What I think we will be faced with is a terminology change. Sometimes I call topics in development "topic objects", as they may or may not be the final topic. These topic objects are still chunks of content, but now their content is determined by their reusability. (For great articles about reusability, see Michael Hughes' blog. He mostly focuses on DITA...after all, he works for IBM...the concepts can be used with any authoring tool.)
Do you use different terminology to explain the difference between topics in development and topics in the output? Do you think new terminology will help? Or will it just make this more confusing?
08/07/08
FrameMaker support lists
FrameUsers is dead. Again. Still. (I think.) For some reason, the fact that no one can access the site this week is causing consternation, yet as I understand it, the site hasn't been available for awhile.
To solve the problem, folks have been creating new user groups. Now, there's nothing wrong with user groups...I run several myself.
Thing is, a perfectly viable list is already available (and has been...it's not a new start-up).
So, if you need a place to talk about FrameMaker issues, visit OmniSystem's Free Framers group.
And for a more humerous take on this whole thing, visit TechCommDood's blog.
07/29/08
Orphan Works Act in consideration
Thanks to Jeffrey Zeldman, I found out about the Orphan Works Act of 2008 (H.R. 5889). A link from his site took me to the Take Action site so that I could send emails to my representatives.
So far, I've heard back from Congressman John F. Tierney. But I'm not really sure how he's going to vote...his email states that he has noted my opposition and that he "will continue to support policies that ensure the fair and equitable treatment of all artists and their artwork."
He then says, "Should H.R. 5889 come to the floor of the U.S. House of Representatives for a vote, I would be sure to keep your concerns in mind." Um...thanks, I guess. Does that mean that you're going to vote to preserve my rights as author?
And the Orphan Works act doesn't only apply to art:
"The Orphan Works Act defines an "orphan work" as any copyrighted work whose author any infringer says he is unable to locate with what the infringer himself decides has been a "reasonably diligent search." In a radical departure from existing copyright law and business practice, the U.S. Copyright Office has proposed that Congress grant such infringers freedom to ignore the rights of the author and use the work for any purpose, including commercial usage." See About this Legislation for more information. (Note that this description is focused on artists and photos/artwork.)
I don't know if I should try to figure out how to reply to him (the email sends me back to his site to reply) or just cross my fingers.
:: Next Page >>
helpstuff blog
Thoughts and more from helpstuff.com...
| Next >
| Mon | Tue | Wed | Thu | Fri | Sat | Sun |
|---|---|---|---|---|---|---|
| << < | > >> | |||||
| 1 | 2 | 3 | ||||
| 4 | 5 | 6 | 7 | 8 | 9 | 10 |
| 11 | 12 | 13 | 14 | 15 | 16 | 17 |
| 18 | 19 | 20 | 21 | 22 | 23 | 24 |
| 25 | 26 | 27 | 28 | 29 | 30 | 31 |
Search
Categories
Archives
- August 2008 (4)
- July 2008 (1)
- June 2008 (4)
- May 2008 (4)
- April 2008 (4)
- March 2008 (4)
- February 2008 (3)
- December 2007 (2)
- November 2007 (3)
- October 2007 (6)
- September 2007 (6)
- August 2007 (3)
- more...