If you're customizing a WordPress theme, it's best to create a child theme out of the WordPress theme. With a child theme, you can update the parent theme when updates are available. Any customizations you make to the child theme will be retained. Here's how it works. If you'll be creating a child theme for the Twenty Twelve theme (whose folder in wp-content/themes is "twentytwelve"), create a folder called twentytwelve-child and upload ...
Talk Plugin for Atlassian Confluence If you use Atlassian Confluence for creating documentation, you might have noticed that it lacks something that is essential for technical writing — a reviewing feature. Talk Plugin can fix that. Talk Plugin for Confluence allows you to leave your comments everywhere on Confluence pages and blogs and take part in discussions with your colleagues. Moreover, Talk can save you a great deal of time with it...
I recently received a comment from a reader who sent me a wish list for technical writing tools. Sam from Canada writes, Hi Tom, I've been enjoying your posts along with Mark Baker's. You both have good points about technical writing trends. I could be totally wrong, but maybe it's not the tech writers that are resisting change. Maybe it's the companies making the tools/money that are resisting change. I can't believe I'm the only writer ...
I had a conversation with a developer the other day about help material. He said that when he sees static pages, he assumes the content is out of date. He prefers forum threads because he can see the dates, and because forums contain real information from people using the product. He likes wikis because he can easily check to see when the information was last edited and by who. One concern he had in our migration away from wikis to a help...
I've noticed a trend in search results lately. Users are searching for my help products and landing on our technology blog that has articles about the topic rather than landing on the help material for the product. For example, a user might have an issue with "newsletter," so he or she searches for newsletter and lands on the beta testing announcement for newsletter that I wrote for our technology blog months ago. The help for newsletter ...
http://www.toobigtoknow.com/ One of the most interesting chapters in Too Big To Know is David Weinberger's discussion of long and short form content. I found the chapter particularly relevant because just the other day, I published a 3,700 word post and had a reader comment that the length — for a blog post — was heinous. I'm not saying the commenter was out of place to object to such length online, since I too sigh at long posts, but he...
Listen here: In this podcast, I talk with Mark Baker from Every Page Is Page One about the ideas he discussed in his Lavacon presentation: Include It All, Filter It Afterwards. This is a line from David Weinberger's book Too Big To Know, which explores the way that knowledge is taking the shape of a network rather than the traditional book. The podcast is about 45 minutes long. Similar to other podcasts, the format work...
I'm going to experiment with some new podcasts, but I want to try something different. The other day I was listening to Boagworld on the way to work, because I think Paul Boag is one of the most successful and longstanding podcasters. He starts out with some playful cohost banter, followed by a few news items that he discusses with his cohosts, and then gets into some techniques and principles for web design, and then usually interviews s...
This year I'll be traveling to Manchester, England to the User Assistance Europe conference there and presenting the following: Make Your Content More Findable When Users Browse and Search Users tend to search help material when they have a specific question they're looking to answer. In contrast, users tend to browse help material when they don't know exactly what they're looking for. Browsing often leads to better searching, and more s...
http://www.toobigtoknow.com/ After my last post, I thought I should start reading Weinberger's Too Big to Know. I liked his previous book, Everything Is Miscellaneous, and so far this one is engaging too. In Too Big to Know, Weinberger talks a lot about knowledge, and how the Internet changes what we know. He says that if the scope of our group is large enough, as is the case with the Internet, there's usually someone out there with the ...
One of the more memorable presentations I attended at Lavacon in Portland was Mark Baker's "Include It All, Filter It Afterward" presentation. You can view the slides from his presentation here. I also embedded them from Slideshare below. Include it all. Filter it afterward. from mbakeranalecta Because I liked the presentation so much, I want to explore the ideas a bit more, as well as integrate the discussion into my ongoing theme abo...
It seems that the manual for almost every product I buy starts off by congratulating me for having purchased the product. I recently bought a waterproof iPod shuffle to listen to audio books while I swim, and since I couldn't figure out how to switch playlists on the device, I turned to the manual. Here's how I'm greeted: Another congratulations cliche "Congratulations on purchasing your iPod shuffle." Have you seen this congratulations ...
I recently listened to Your Brain at Work, a productivity/neuroscience book by David Rock. Rock's main argument is that by better understanding your brain, you can align the way you work with your brain's tendencies, patterns, and instincts to be more productive and successful. Rock keeps your attention throughout by implementing a narrative conceit involving two people, Paul and Emily, in before-and-after scenarios. Paul and Emily make ...
I recently attended an internal conference at my work for instructional designers. The focus of the conference (as I assume the focus is for many instructional design conferences) was on "learning." I always find the emphasis on learning in the ID crowd fascinating, because this is rarely a word that tech writers use, yet our goals are largely the same. An action-based model for learning The keynote speaker presented a model for learning...
If you've ever been frustrated by the lack of keyword highlighting in Flare's HTML5 output, check out the script Scott DeLoach created for this. It works pretty well. Details for the HTML5 Highlighter are on Scott's site: http://www.clickstart.net/highlighter/. I created a quick video tutorial showing how to actually incorporate the highlighter in Flare. It's not difficult to incorporate but does require a few steps. (Make sure you chan...
