Archive for the ‘technical communication’ Category

The Dynamic Publisher

Tuesday, May 8th, 2012

A while back, Scott Abel announced the launch of the Dynamic Publisher site. If you’re interested in content managment, XML publishing, or DITA, you’ll probably want to keep an eye on this one. There isn’t a huge amount of content on it right now, but what’s there is pretty good.

Just a quick note to say that in addition to my many other roles, I’m also now the editor of TheDynamicPublisher.com. Formerly a web property used by Quark to publicize its dynamic publishing products, TheDynamicPublisher.com is now a vendor neutral home for all things related to dynamic content. You’ll find interesting articles about XML, content management, eBooks, semantic web, content conversion, content quality, as well as information about events, training, and industry news.

But, alas, I can’t do it myself. That’s where you come in. Stop by the blog and take a look around. Read some articles. Leave some comments, if you like (and I hope you do). Make some suggestions, should you feel inclined.

Interview with Joshua Tallent published

Wednesday, May 2nd, 2012

One of the highlights of my attendance at the WritersUA conference in March was getting to interview Joshua Tallent, the author of Kindle Formatting and the founder of eBook Architects. He gave two presentations at WritersUA – my notes from those are up on TechWhirl.

The interview covers a lot of ground: what technical writers can contribute to ebook production, the future of e-reader devices and ebook formats, and why publishers are so uncomfortable with ebooks, among other topics. I really enjoyed talking with Joshua and I hope you’ll enjoy the interview, which is now published on TechWhirl.

Do you think that there’s an opportunity here for technical writers who are looking for new challenges to move into this field? Tech writers have been working with various online formats for quite a while and we understand how to structure content and make it easier to display and use in various output formats.

JT: Yeah, that would be really good for the publishing industry to see. There’s always a lot of bleed over that would be helpful on both sides. As long as we can get past the single source idea, because I don’t think that single source will be possible in the near future. There are just too many proprietary display engines and proprietary formats that are coming out.

I think the technical writing community can teach the publishing industry a lot about metadata, a lot about taxonomies, a lot about the deep information that you have, and the capabilities that you have to draw that information out and to give people more data as they read. That would be helpful.

Also tech writers could help with interfaces. There are a lot interfaces used in technical writing, search interfaces, indexing interfaces, that would also be helpful in the standard eBook market.

Tell me about yourself

Tuesday, May 1st, 2012

Having just had to interview some writers for a contract position, I’ve been thinking a lot about job interviews. One of the standard questions that interviewers like to use is “Tell me about yourself”. It can be a tricky question. US News has an article that talks about how to handle this question should you be on the receiving end.

“Tell me about yourself” is one of the most common openers to a job interview, yet job-seekers are often unsure what employers really want to hear in response. Should your answerinclude personal information? Should it focus on selling yourself, or just give the facts? What is the employer really asking?

Let’s translate it: “Tell me about yourself” in a job interview means “give me an overview of who you are, professionally speaking.” There’s a reason this is asked at the very beginning of an interview; it’s a way of saying, “Give me some broad background before we dive into specifics.”

You should be ready with a one-minute answer that summarizes where you are in your career, generally with an emphasis on your most recent job and the strengths of your approach.

How to write a software documentation plan

Monday, April 23rd, 2012

If you’re a technical writer who’s worked on a large software project, you probably have had to prepare a software documentation plan. This article explains how to write one. Speaking from personal experience, I think it’s a very good article that should give you the basis for a solid plan. It does list a lot of things that may not apply to any particular situation but if you follow it, you won’t miss much.

What is a software documentation plan? This is a project plan for the technical documents you plan to write for the next software release. Like a standard project plan it captures the resources, requirements, costs, and deliverables.

As this is for technical writers, the documentation plan will focus on the content you intent to deliver; it may include the document format, estimated page count, delivery format and other such items.

I’m bookmarking this at work for future reference.

Shakespeare and Document Control

Friday, April 20th, 2012

I’ve never thought of Shakespeare in the context of technical writing, but in this article Josh Stubbs makes the connection. It’s a great article and definitely worth reading – you’ll probably learn something about Shakespeare you didn’t know and it’ll help you with your documents as well.

There is no doubt that William Shakespeare was an extraordinarily gifted writer but his document control left room for improvement.

This article will show several document control mistakes that Shakespeare made and describe why the issue is still relevant to technical writers 400 years later

#1 KING LEAR – Not Uniquely Identifying Each Document and its Release

Shakespeare produced two different versions of King Lear. Between these two versions there are nearly 300 different lines of dialogue that significantly affect the over all tone of the play.

Scholars have debated which was the Bard’s preferred version. Was one the fully realized tragedy exploring the themes and ideas to their conclusion or was the other a more direct and visceral plot meant to capture the attention of wandering groundlings?

WHY IT IS RELEVANT

Readers will make their own assumptions about the various drafts of your document and use their own method to determine several documents with similar names. A reader will naturally assume that a document is complete if it is labelled “Final Draft” or “Final Draft (2)” and they do not know that there is FINAL Final Draft or a Final Draft (3).

New article on TechWhirl: HTML5 session summaries

Thursday, March 29th, 2012

TechWhirl has published the first of my WritersUAsession summaries: HTML5 and CSS3 to the Point and User Annotations with HTML5.

By now, most writers know that both HTML and CSS have been updated with new standards. However, browser and tool vendors are just now beginning to support them. At WritersUA, Scott DeLoach and Dave Gash each gave presentations that covered aspects of the new technology that impact user assistance and thoughts on how we’ll be dealing with HTML5 and CSS3  in the coming year.

Update: I suspect that Scott Prentice would have included this as an example of just how powerful HTML5 is if it had been released before WritersUA. It’s a multiplayer online role-playing game written entirely in HTML5. It’s developed by the Mozilla Foundation and is being released under an open source license.

http://boingboing.net/2012/03/27/free-open-all-html-mmo-from.html