A directory of resources inthe field of technical communication.


41 found. Page 1 of 2.

About this Site | Advanced Search | Localization | Site Maps

1 2  NEXT PAGE »



Advocate for Community Documentation

Let’s say that the most driven and driving developer on your team, who also happens to be a popular blogger, comes to you and asks why your end-user documentation doesn’t allow comments or ratings. Rather than stammering something about Wikipedia’s latest scandal, or reaching for imperfect responses that sound like lame excuses, do your homework and learn best practices from others who are implementing social web content that is conversational or based on community goals.

Gentle, Anne. Just Write Click (2010). Articles>Documentation>Wikis>Social Networking


The Atlassian Contributor License Agreement Comes of Age

In early March we opened up the Atlassian documentation to the wider community. We added a CC-by (Creative Commons Attribution) license to our product documentation. We invited people to contribute to our documentation after signing an Atlassian Contributor License Agreement (ACLA). At that stage, the ACLA was just starting its three-month trial. The trial period has now ended, and we're delighted to say: it's a go!

Maddox, Sarah. Atlassian Blog, The (2009). Articles>Documentation>Wikis>Case Studies


Author-it User Wiki  (link broken)

One of the strengths of the Author-it is the help and support that members of the Author-it User Group provide to each other. But it occurred to me a lot of this useful information is lost and buried in the mountain messages and not captured anywhere. I also thought that it would be useful to have a repository of this great information.

Blunck, Hamish. HamishBlunck.com (2009). Articles>Documentation>Wikis>Author It


Baselining Documentation on a Wiki

The dynamic nature of wikis can cause a few headaches when you need to baseline documentation that's on a wiki to correspond with the release of your product. This blog post looks at some ways in which you can try baselining wiki content.

DMN Communications (2008). Articles>Documentation>Technical Writing>Wikis


Building a DITA-Wiki Hybrid  (link broken)   (PDF)

Learn about theoretical and practical examples of merging DITA (Darwin Information Typing Architecture), a structured authoring methodology, and wiki’s freeform authoring and editing capabilities.

Gentle, Anne and Lisa Dyer. Intercom (2008). Articles>Documentation>Technical Writing>Wikis


Can Lightweight Markup Languages Be Used for Documentation?

A lightweight markup language uses syntax that is similar to wiki syntax -- keyboard characters are used to define formatting. This blog post argues that if your documentation needs are simple, and you have a low or non-existent budget, then a lightweight markup language might be worth investigating.

DMN Communications (2008). Articles>Documentation>Programming>Wikis


Care to Write Army Doctrine? With ID, Log On

In July, in a sharp break from tradition, the Army began encouraging its personnel — from the privates to the generals — to go online and collaboratively rewrite seven of the field manuals that give instructions on all aspects of Army life. The program uses the same software behind the online encyclopedia Wikipedia and could potentially lead to hundreds of Army guides being “wikified.” The goal, say the officers behind the effort, is to tap more experience and advice from battle-tested soldiers rather than relying on the specialists within the Army’s array of colleges and research centers who have traditionally written the manuals.

Cohen, Noam. New York Times, The (2009). Articles>Content Management>Documentation>Wikis


Consistency and Community-Generated Content

I’ve been collecting examples of wildly inconsistent writing lately. I’m not sure why these have stuck out to me, but when I think of book sprints and community writing events, consistency is an important, though sometimes difficult, goal and outcome.

Gentle, Anne and Janet Swisher. Just Write Click (2009). Articles>Documentation>Style Guides>Wikis


Review: Conversation and Community by Anne Gentle

Offers a strong recommendation to read Anne Gentle’s Conversation and Community: The Social Web for Documentation, which provides tips for incorporating wikislices, screencasts, and comment/feedback systems, into your user assistance.

Mulligan, Peg. PegMulligan.com (2009). Articles>Reviews>Documentation>Wikis


Creating Documentation With A Wiki: The DITA Storm Project

DITA is natural. Do XML/DITA conversion research now. Wiki is especially good for iterative writing. Structured wiki authoring in coming.

Abel, Scott. SlideShare (2007). Presentations>Documentation>Wikis>DITA


Daisy: WYSIWYG Wiki for PDF Books   (PDF)

If you need the collaborative aspects of a Wiki combined with DITA's modular topics and publishing capabilities, then DAISY might just be the system you need--and it's free. DAISY provides WYSIWYG editing for Wiki pages that can be combined to publish books, either in a PDF or as a single HTML page.

Armstrong, Eric. Sun Microsystems (2008). Articles>Content Management>Documentation>Wikis


A Few Surprises in Using a Wiki for Documentation

Recently I’ve been working on a simple calendar project that uses a wiki for documentation. Although I’ve heard a lot about using wikis for documentation, and have even used them in the past, I ran into a few surprises this time.

Johnson, Tom H. I'd Rather Be Writing (2009). Articles>Documentation>Content Management>Wikis


FLOSSmanuals.net: A New Wiki Help Authoring/Publishing Tool Hybrid

Flossmanuals.net is a new wiki help authoring/publishing tool hybrid that, as far as I know, is completely unique. The site is more than a wiki. It allows groups of authors to create specific chapters independently. You can then remix the chapters into any arrangement and selection you want through a drag-and-drop interface.

Johnson, Tom H. I'd Rather Be Writing (2008). Articles>Documentation>Help>Wikis


Getting Content Into and Out of Wikis

As wikis mature, we’re using them for more complex business cases such as technical documentation, business analysis and project management. It’s becoming more and more interesting, if not essential, for wikis to support the import and export of content to and from other formats. Most wikis allow you to convert their pages at least to PDF and HTML. But what of other formats, and what about tools for getting content into wikis as well as out of them?

Maddox, Sarah. ffeathers (2009). Articles>Content Management>Wikis>Documentation


Going from Word to Wiki

One writer's experiences and thoughts about moving content from Microsoft Word to a wiki.

DMN Communications (2008). Articles>Documentation>Wikis>Case Studies


I Got Dragons and Tweets in My Documents

There’s a place for a lighter touch in much of the online documentation we write. It’s a delicate balance. On the one hand, it’s important that the writing style does not annoy or offend the reader and does not detract from the content. We also need to be aware of people whose first language is not the one we’re writing in. On the other hand, the occasional touch of humour or personality can focus the reader’s attention onto the page.

Maddox, Sarah. ffeathers (2009). Articles>Documentation>Wikis>Case Studies


iFixit: The Free Repair Manual

Attempts to make it easy for you to fix things yourself with our online step-by-step repair guides, troubleshooting tips, and a community of repair technicians who want to help.

iFixit. Resources>Documentation>Wikis


Informal Help via Electronic Conversation Can Lack a Certain Professional Quality

Much documentation and training is delivered in one direction—the writer provides content, and the user consumes it. Perhaps this is one reason that technical communicators are looking for ways to create a conversation. It’s easier to address user problems when you can ask follow-up questions and get details. In a one-way delivery, you have to hope that what you provide will cover what’s needed. In a conversation, you can constantly get more information and react accordingly. Still, in an instant message, chat, or forum conversation, it can be hard to be clear.

Gryphon Mountain (2009). Articles>Documentation>Wikis>Social Networking


Is a Documentation Wiki in your Future?

If we can solicit user participation in a Web 2.0 knowledge community (a volunter wiki documentation, for example), we might have a powerful means for creating high quality content. But how should this process work?

Hackos, JoAnn T. Center for Information-Development Management (2007). Articles>Documentation>Content Management>Wikis


The Medium is the Delivery Method

A question that technical communicators frequently ask about wikis is "How do I get the documentation out of a wiki?" A simple answer: "Don’t worry about it." Because the wiki is the delivery method.

Nesbitt, Scott. DMN Communications (2009). Articles>Documentation>Content Management>Wikis


Musings on User-Generated Documentation

User-generated documentation is a big issue in technical communication circles. If properly done, tapping into the knowledge of users can improve the quality and breadth of your documentation.

DMN Communications (2008). Articles>Documentation>Technical Writing>Wikis


Organizing Content 12: From Help Authoring Tools to Web Tools, Especially Wikis

The importance of single sourcing the long print manual is becoming less of a demand (have you handed someone a 100+page manual lately that someone accepted with eagerness? ) I predict that in several years time, we’ll see a major shift towards web-based tools in tech comm, especially wikis.

Johnson, Tom H. I'd Rather Be Writing (2010). Articles>Documentation>Single Sourcing>Wikis


The "Quick Web" for Technical Documentation   (PDF)

So how did the wiki become a seemingly permanent fixture in the landscape of today’s Web? Which wikis have succeeded as technical documentation, and how can we replicate their success?

Gentle, Anne. Intercom (2007). Articles>Documentation>Technical Writing>Wikis


Ramping Up on Mediawiki

Previously I thought wikis might be limiting because the formatting options seemed so primitive--either bullets or numbers or headings, and not much else. Now I realize that I have so much to learn. I’m only on stair three of about a hundred stairs.

Johnson, Tom H. I'd Rather Be Writing (2009). Articles>Documentation>Content Management>Wikis


Reviewing Wiki Documentation via Crucible

I have been playing around with Crucible, Atlassian’s peer code review tool. The latest version of Crucible allows you to review Confluence wiki pages. This is a new feature, so I decided to try it out. Also, I was wondering why you might want to use an independent tool to review a wiki page, when you could instead just add comments to the page or update the page directly.

Maddox, Sarah. ffeathers (2009). Articles>Web Design>Documentation>Wikis



Follow us on: TwitterFacebookRSSPost about us on: TwitterFacebookDeliciousRSSStumbleUpon