Archive for the ‘blogging’ Category:
What’s your favorite JustWriteClick post?
I like to keep an eye on what posts are popular, although with a blog, you can define popular in many different ways. Most comments, most views, or highest average daily views. So if you’re new to my blog, (and the recent uptick in subscribers might indicate that some of you are, so welcome!) you might enjoy these previous posts.
Here are the most popular posts based on total views (I think this is slightly inaccurate for the life of my blog but still interesting):
- Wiki as forum, FAQ, HTML editor, XML editor, or CMS?: Wiki as the new FAQ I discovered and have been meaning … 7 comment(s)
- EMC Adds Google Desktop to EMC Documentum Federated Search Environment: An excellent combination, Google search for your enterp… 0 comment(s)
- Twitter for usability testing or doc testing? Sure, here’s how: My coworker went to SXSW Interactive this year, and I m… 1 comment(s)
- Writing End-User Documentation in an Agile Development Environment: This article was original published in the June 2007 is… 17 comment(s)
Here are the most popular posts based on average daily views:
- Wiki as forum, FAQ, HTML editor, XML editor, or CMS?: Wiki as the new FAQ I discovered and have been meaning … 7 comment(s)
- EMC Adds Google Desktop to EMC Documentum Federated Search Environment: An excellent combination, Google search for your enterp… 0 comment(s)
- Love, love, <3 The Twitter Book: Wow, just got a print copy of The Twitter Book by Tim … 1 comment(s)
- Conversational robots: Move over qmail mailer-daemon*, Little MOO from moo.com… 2 comment(s)
- Twitter for usability testing or doc testing? Sure, here’s how: My coworker went to SXSW Interactive this year, and I m… 1 comment(s)
Here are the most popular posts based on number of comments:
- STC Intercom – themes and advice wanted: I’m quite flattered and humbled (and more than a little… 25 comment(s)
- Look out, updated headshots are coming: The headshots I’ve been using (including the one that s… 19 comment(s)
- Writing End-User Documentation in an Agile Development Environment: This article was original published in the June 2007 is… 17 comment(s)
- DITA and wiki hybrids – they’re here: Lisa Dyer and Alan Porter presented at last week’s … 14 comment(s)
- Arrrrrrr, mateys!: I haven’t been churning out blog posts for a while due … 14 comment(s)
What are your favorites – the most discussed or the most widely read? Feel free to leave a comment.
Webinar available now from Scriptorium Publishing
I gave a webinar this week for Scriptorium that will be available online titled “Documentation as Conversation.” The fact that it’s recorded lets you avoid scurrying around rearranging meetings in Outlook just to attend it. It sold out which was great to hear, but I like that the message and conversation continues through the recording. One of my fun examples was the Wordle visualization of my tags from the social bookmarking tool, del.icio.us.
During the question and answer session, someone mentioned they felt like social media made her feel like we’re becoming paleontologists. I think she referred to my many examples of how to “stalk” your users to learn more about them and their goals, especially if you document software. I search for my product’s name in Indeed.com job listings as well as look for job titles with my product’s name in LinkedIn to learn more about the people I’m writing for. I wrote up the technique in this blog post, Find your user’s vocabulary and use his or her key terms as keywords.
I also had a follow up email saying that people want to know, where should my team start conversations? Or where should we focus our time if we do start? In my book, I talk about phases: Listen, Participate, Share, Build a Platform. I think you should start with listening and monitoring what’s already being said. Next, start by commenting on blogs or by blogging yourself. A baby step towards blogging is to blog on an internal site, behind your firewall, just to limit your audience if that makes you more comfortable.
Also I’d recommend trying out tools that are already installed that you don’t have to maintain and install yourself. For example, I started justwriteclick.com on wordpress.com and paid $10 a year to map my domain name. When I knew WordPress was a good fit for me and my blogging and site needs, I went ahead and found an ISP and installed WordPress myself. And two years later, I’m hooked on WordPress and I’m even attending WordCamp Dallas in a few weeks.
Sharing content is the next step, and the final step is providing a platform for users to bring their own content in. These steps take time but you will learn valuable lessons along the way and hopefully avoid any stumbling or disastrous results. It’s okay to fail, though. You learn new lessons with each attempt and approach.
So keep an eye out for the recording of the webinar, Documentation as Conversation. The price remains at USD $20 and you get to schedule listening to it any any time of the day. It’s an hour long and if you do listen to the recording, feel free to contact me via email with any questions. I am looking forward to hearing even more feedback!
What is Anne Gentle up to?
I finally feel some energy returning after my eye injury about a month ago, although my right eye remains dilated which still means that side is a bit out-of-focus and I don’t like driving at night. I feel like I need to give a status update or some such. So here goes.
Winter Camp
With luck my eye should be just fine in time for a big event coming up: Winter Camp 09 the first week of March. I’ll be representing and working for FLOSS Manuals at this event, held in Amsterdam. From the description, it will be an amazing week:
Network Cultures Winter Camp will be a mix of presentations and work spaces with an emphasis on getting things done. It will be a four-day program of work spaces and plenary presentations, in which a dozen networks (each of which has 5-15 people) can work on their specific current topics.
The format was inspired by a cardboard box art installation that activates a temporary warehouse of contemporary knowledge from what I can gather from a translation of the page, Re-fitting ideas. Come on, that’s incredible. I am so thrilled to be a part of it. And I know it’s going to be a week of hard work.
Preschool website completed, using Wordpress 2.7
We’ve also finished the preschool website I mentioned in my interview with Michael Silverman of Duo Consulting. We used WordPress hosted at Midas Networks. I recorded some screencasts with Jing to show other parent volunteers how to edit content and work with images. All the photos on the site were taken by parents so it’s quite the “do-it-yourself” website. I am hoping that Wordpress 2.7 will be easy enough for even those in our volunteer and staff group who are not technically savvy but still give us the growth towards more content creators that we have in our goals for the site.
FLOSS Manuals and OLPC
We’ve sold over 200 copies of the OLPC Laptop Users Guide on Lulu.com, and Adam Hyde gave a copy of one of FLOSS Manuals’ books to Bob Young, the CEO of Lulu, while they were at the O’Reilly Tools of Change conference. Impressive. I still plan to make the Sugar Users Guide better. Adam Hyde and I are working on a book about how to run a Book Sprint in FLOSS Manuals, naturally, and we would welcome additional contributors.
DITA and Web 2.0
I’ve been approached to help put a public face on standards for DITA and Web 2.0 projects such as DITA for wikis (an example is Lisa Dyer’s DITA2Wiki project on SourceForge) and DITA for blogs (another example is DITA to Wordpress or DITA and microformats).
STC Intercom Editorial Advisory Panel
I’ve been pretty impressed with the STC Intercom issues in 2009 so far, but I wrote one of the articles so perhaps my judgement would be playing favorites. I would like to gather feedback from STC members and non-members who read the articles – how’s the content grabbing you this year?
Author-it 5.2
It looks as though 5.2 is the version of Author-it that will allow us to upgrade from 4.5. Our content just wouldn’t publish adequately (Word or HTML) on 5.0 or 5.1, but now that 5.2 is released, fingers crossed, we’ll be moving to 5.2 soon. I should write a blog post about some of our testing on our 20,000+ object database. I’m getting used to the Ribbon Bar as I continue to work in Word 2007, and Author-it’s 5.x interface feels a lot like Word 2007.
Writing a book, do tell me what you want to know
Last but certainly not least, I’m working with a professional editor to try to finalize my book about documentation as conversation that examines the power of social media for writing projects. It walks through the myriad of possibilities of different types of social media tools and analyzes how writers and communities are using these tools for technical documentation. Look for it this spring!
Corporate blogs learning from reviewers
Diane Wieland has a great post at the Duo Consulting blog called Free Expert Blogging Advice that points to the Fortune 500 Business Blogging Wiki. In the blog entry she encourages bloggers to learn from the reviews of blogs using a standard set of criteria found at Business and Blogging. They say:
Good Blogs will be:
- easy to find
- frequently updated
- written in an engaging manner
- relevant
- focused
- honest
- interactive
- responsive
Bad blogs will be:
- hard to find
- infrequently updated
- censored
- one-way communication
- unresponsive
- defensive
Ugly blogs will be:
- boring
- inaccurate or misleading
- filled with technical jargon (for a non-technical audience)
- full of regulations and legal disclaimers
- self-absorbed
- press releases in disguise
It would be interesting to apply these review criteria on technical writing tool vendor’s blogs. MadCap has what I consider to be a groundswell-blogger-style with personalities first, company second. Adobe’s Technical Communication Suite team’s blog has a distinct corporate and enterprise appeal while still identifying posters by name and letting you get to know them. ComponentOne has a collection of blogs and bloggers but buzz generation fills the first page. Author-it has a new nicely branded Wordpress blog. WebWorks has a group of bloggers also and Alan Porter is my favorite blogger there. TechSmith hosts three blogs – the Jing Blog, Screencast.com Blog and The Visual Lounge Blog.
I won’t apply bad or ugly criteria to any of these. I’m happy they’re blogging. What are your thoughts as more and more of “our” vendors begin to join the blog world? Have I missed any of your vendor favorites?
For even more corporate blogging resources, see the link list on Rhonda Bracey’s post entitled Corporate/business blogging.
How do people converse about technical topics today?
I have seen the eminent reinvention of technical documentation as we know it, which inspired me to begin chronicling my own observations and shifts in the field of communicating technical topics through conversation.
One such revealing moment happened while I was working on documentation for the One Laptop Per Child project on their wiki at wiki.laptop.org. The Give One Get One rollout was hurtling towards the organization, and they had not completely designed a support system nor did they have a user manual ready to view online or to print. The Give One Get One program gave the opportunity for the first time for anyone in the U.S to buy a laptop and know that one additional laptop would be sent to another country. Through the nearly heroic efforts of one person building a new team self-named the Support Gang, an all-volunteer crew if I understood the situation correctly, a wiki-based Support FAQ came to life and a support email address was created and a support team made of volunteers was staffed.
The amazing revelation to me was that the wiki FAQ could and did answer so many questions because they came from real people, customers of the Give One Get One program. The questions were real questions from real users, so there wasn’t a delay in seeking out a subject matter expert. These were conversations happening on the wiki Edit tab or on the Discuss tab. See the History on wiki.laptop.org/go/Support_FAQ for examples of the questions and answers that happened, and also notice the time stamps for some of the answers. The immediacy of the response is practically like an Instant Messaging conversation via the wiki FAQ page.
How did the community completely fill out these highly useful wiki pages? Or did just a few volunteers do it? It was the work of a few good people continuing conversations with real users or potential and upcoming customers of the little laptop. Community-supported email, forums, and IRC discussions rolled into these wiki pages. Supporting users was the work of college students, of parents who were anticipating their laptop’s arrival, and other non-professional writers. One such volunteer was Katie, a mom who is a mathematician by day, and an excellent FAQ writer by night. Her wiki pages and research around the wireless connectivity were extremely helpful to everyone who bought a Give 1 Get 1 laptop. Without her dedication, many of us couldn’t have connected to the Internet, and the user manual I continued to work on benefited greatly from her wiki contributions and knowledge sharing.
That the community created such helpful, useful, readable pages was a complete turnaround for my attitude about what sweat goes into writing and rewriting carefully crafted topics to then submit for review and sweat over again and again until a deadline comes. I thought, instead of toiling over the exact words and following a style guide, should I try to recruit and entice and motivate contributors from every professional or amateur background possible? Some paranoid types say that laymen and amateur writers could beat us at our own chosen profession. But “beat” is not the right term. It’s not a contest or an all-out competition, it’s a group effort towards a shared goal.
Armed with this revelation, I began studying how conversations and community attract the right combination of content and information to offer the right amount of technical communication delivered in the right manner. Part of my study involved hands-on creation of end-user documentation, including a PDF manual, using the OLPC community’s wiki at wiki.laptop.org/go/Simplified_user_guide, and also using a highly customized wiki engine at FLOSS Manuals, www.flossmanuals.net.
Much of the labor and toil on those wiki pages and especially with the community volunteer atmosphere of OLPC and FLOSS Manuals is coming to fruition next week at the FLOSS Manuals BookSprint to document the XO laptop and the Sugar operating system for the students, parents, and teachers benefiting from the One Laptop Per Child project around the world.
Fun with Wordle
I love this visualization toy, Woordle at http://wordle.net/, and as it turns out, I use the word “love” quite a bit. That and “really.” Who knew?
It’s quite fun to make a Wordle because of the animation you see while the word “cloud” is added to, so I highly recommend trying it for yourself. You can change the colors and fonts. Here’s the Wordle based on my blog:
I also enjoyed reading the backstory of Wordle’s creator – he works for IBM and created Wordle in his spare time with his employer’s approval. Neat!
BookSprint for Floss Manuals writing for the XO and Sugar
I’ve been busy lately working on plans for a Floss Manuals BookSprint. A BookSprint is a week-long concentrated effort of technical writers getting together to create a manual for free, libre open source software products. BookSprints are like a workshop where writers come together to learn how to write good user documentation. BookSprints are also a social experience where writers come together to form a community who share common goals and experiences.
Writers are giving a week’s time to be curators of information housed in wikis and websites everywhere, bringing it all together into the FLOSS Manual TWiki implementation to be ready for online viewing or gorgeous print output. If you’re interested in joining us for a day or all week, we’d love to have you. We’re planning to invite local students to the event also.
This picture shows the recent Inkscape BookSprint held in Paris France. We’re planning to hold the XO/Sugar BookSprint here in Austin, but I’m guessing the collection of laptops and cables will be the same here as there!
In this case, we’ll produce a comprehensive manual for the kids, families, and teachers using the little green XO laptop. While the manual that exists at flossmanuals.net/olpc_simple is a targeted effort, it is outdated for the new line drawn between hardware (XO) and operating system (Sugar). Our hope is to expand the manual in advance of the new expanded Give 1 Get 1 program will give educators and children a chance to learn about their laptop, repair it, program with it, and teach others.
What can you do to help? Right now, I’m raising money and asking for in-kind donations to help with this concentrated effort. Here are some ideas, although you can come up with creative ideas yourself if you want!
$500 would provide hotel accommodations for a writer
$250 would provide a catered lunch for all the writers
$100 would provide gas money for many writers all week
Updated to add: You can also directly give donations at http://en.flossmanuals.net/donate.
Sponsorship earns not only good “whuffie” but we’ll list your name or business name on these websites: FLOSS Manuals, JustWriteClick, Sugar Labs, and OLPC.
An exciting aspect of this BookSprint is the international effort behind it. Adam Hyde, founder of Floss Manuals, is planning to make the trek to Austin from Amsterdam, and there’s a French Floss Manuals coordinator working behind the scenes to ensure that the document can be translated to French. I’m also working with Yama Ploskonka, admin of the OLPC-Sur list of Spanish-speaking OLPC supporters to find Spanish language translators.
All in all, this is a very exciting effort and I’d love to get readers of JustWriteClick involved in any way you’d like. I’m very excited to be part of this effort and pleased to play host – let’s gather some more community around the BookSprint to make it a success.
Examples of content providers blogging for customers
Sarah O’Keefe wrote up a nice summary of the WritersUA Pundits Panel, and Bogo Vatovec (of Bovacon) made a statement something like this:
Introverted technical writers will not be writing help any more and will be replaced with experts moderating support forums. … Technical writers can no longer afford to hide in their cubes, they must go out and become experts and talk to the users.
I left a comment on her post that I see a similar future for our profession, although I do not have a value placed on introversion versus extroversion – likely introverts make perfectly good community managers and forum moderators since they can do that from their desks for the most part.
But, it does take some bravery to put your real personality online. I’ve found that a few of us are doing that – going from technical writer to blogger writing directly to customers.
While many of us blog to an audience of other professional writers, there are technical writers out there who are blogging to their end-user audience. Here are two examples:
- National Instruments here in Austin has a blog called “technically speaking” that they use not only to talk about their daily work but also to keep their end-users informed about documentation. For example, here’s a post about a wiki that LabVIEW users will find helpful.
- Another example is Dee Elling’s blog for CodeGear users. This entry offers a great example of a real conversation with customers. I applaud her bravery (and emailed her to tell her) in facing these sometimes abrasive responses with a sense of customer service and helpful attitude. She doesn’t always have a good message to bring (they are working furiously to give their customers more code examples which we all know is time-consuming and difficult). But she brings a message directly to customers anyway.
Is anyone else talking directly to their customer base with their blog? Consultants in technical writing and content management are definitely talking to current and potential clients – Palimpsest is Scriptorium’s blog, The Rockley Blog, The Content Wrangler, and DMN Communications to name a few. But what about conversations with end users? I’d love to see more examples.
It’s the network, not the media, plus, the Content Wrangler Community on Ning
Another one of my takeaways from last week’s South By South West Interactive conference is that it makes sense to use the term “social networking” rather than “social media” to describe sites and tools that help you stay connected with others. We’re not all journalists, and the “media” part of the term seems to signify that you want to share media, but in reality, you want to share interests, ideas, and connect with others.
Join the Content Wrangler Community on Ning
There seemed to be an amazing convergence for me last week, when not only did I witness some neat interactions at the conference in person, online I was also having neat interactions with other members of the Content Wranger Community on Ning. I’ve started a Blogging group there as well, and I posed two questions to the group – one is, How do you find time to write blog entries? and the other is, Blog engine as a CMS? Or CMS as blog engine?
Please feel free to add me as your friend, add a comment, join a group, connect with me on The Content Wrangler Community. I’d like to get to know my readers!
Austin’s own STC president Leah Eaton invited the most people to join the community in the 3-day timeframe for a contest, so she gets to choose from a list of conferences to attend. Naturally, I encouraged her to attend DocTrain West where I’ll be moderating the Meet the Bloggers session featuring Scott Abel, Darren Barefoot, Aaron Davis, Tom Johnson, and Scott Nesbitt.
Look out, updated headshots are coming
The headshots I’ve been using (including the one that stays on my blog at talk.bmc.com) were taken by my husband one morning before work. In fact, my son is on my lap in one of the ones that didn’t make it to the “released” state.
Since those were a few years old, I decided it was time to update my headshots. So I asked my photographer friend Beverly Demafiles to come over to the house one late afternoon this fall for some professional shots. And wow, did she deliver the goods! I highly recommend her services if you’re looking for professional portraits or for wedding photography. She’s here in Austin and does spectacular work.
As a blogger, I’ve found it important to ensure that people know there’s a real person behind the writing. By offering updated photos I think I can continue to ensure that you know it’s really me. Plus, with some of these perspective portraits, you can know that I’m pretty short, really. My friends mostly think I’m taller than I am, though. I guess I must “stand tall.”
A few years ago, I accidentally painted our house pink. Pepto pink in fact. I have since vowed to buy quarts or pints of paint and try out colors on the side of the house so the neighbors can vote before any paint is applied in earnest.
So, in the spirit of trying out portraits before plastering them everywhere, which portrait do you like best? Your vote matters so let me know which ones you like best by leaving a comment with the number.
Subscribe to RSS





Anne Gentle is the author of 
