Writer River » documentation http://writerriver.com social news for technical communicators Tue, 06 Jan 2009 18:13:17 +0000 http://wordpress.org/?v=2.6.3 en http://writerriver.com http://writerriver.com/wp-content/favicon.gif Writer River Coding Horror: How to Write Technical Documentation http://writerriver.com/2008/10/20/coding-horror-how-to-write-technical-documentation/ http://writerriver.com/2008/10/20/coding-horror-how-to-write-technical-documentation/#comments Mon, 20 Oct 2008 14:27:08 +0000 Tom Johnson http://writerriver.com/2008/10/20/coding-horror-how-to-write-technical-documentation/ Coding Horror: How to Write Technical Documentation.

]]> http://writerriver.com/2008/10/20/coding-horror-how-to-write-technical-documentation/feed/ Collaborative Walkthrough Video: A uni … http://writerriver.com/2008/09/03/collaborative-walkthrough-video-a-uni/ http://writerriver.com/2008/09/03/collaborative-walkthrough-video-a-uni/#comments Wed, 03 Sep 2008 13:15:29 +0000 noel http://writerriver.com/2008/09/03/collaborative-walkthrough-video-a-uni/ Collaborative Walkthrough Video:

A unique look at how other organizations deal with documentation design and critique. Plus some really good best practice tips.

]]> http://writerriver.com/2008/09/03/collaborative-walkthrough-video-a-uni/feed/ Best Practices for Editing Modular Docum … http://writerriver.com/2008/08/18/best-practices-for-editing-modular-docum/ http://writerriver.com/2008/08/18/best-practices-for-editing-modular-docum/#comments Mon, 18 Aug 2008 10:49:08 +0000 noel http://writerriver.com/2008/08/18/best-practices-for-editing-modular-docum/ Best Practices for Editing Modular Documentation

]]> http://writerriver.com/2008/08/18/best-practices-for-editing-modular-docum/feed/ Proposed API for tools to help educate computer users online - O’Reilly News http://writerriver.com/2008/08/11/proposed-api-for-tools-to-help-educate-computer-users-online-oreilly-news/ http://writerriver.com/2008/08/11/proposed-api-for-tools-to-help-educate-computer-users-online-oreilly-news/#comments Tue, 12 Aug 2008 00:46:30 +0000 WorkingWriter http://writerriver.com/2008/08/11/proposed-api-for-tools-to-help-educate-computer-users-online-oreilly-news/ Here are some thoughts about how to help developers create adequate tools for educating users. The author asks for feedback on this draft. He shouldn’t just hear from developers and software architects.

Proposed API for tools to help educate computer users online - O’Reilly News.

]]> http://writerriver.com/2008/08/11/proposed-api-for-tools-to-help-educate-computer-users-online-oreilly-news/feed/ What You Leave in Your Wake http://writerriver.com/2008/08/07/what-you-leave-in-your-wake/ http://writerriver.com/2008/08/07/what-you-leave-in-your-wake/#comments Thu, 07 Aug 2008 08:33:15 +0000 shanghaitechwriter http://writerriver.com/2008/08/07/what-you-leave-in-your-wake/ What You Leave in Your Wake

]]> http://writerriver.com/2008/08/07/what-you-leave-in-your-wake/feed/ Beijing Olympics Style Guide http://writerriver.com/2008/08/06/beijing-olympics-style-guide/ http://writerriver.com/2008/08/06/beijing-olympics-style-guide/#comments Thu, 07 Aug 2008 02:15:12 +0000 shanghaitechwriter http://writerriver.com/2008/08/06/beijing-olympics-style-guide/ Beijing Olympics Style Guide

]]> http://writerriver.com/2008/08/06/beijing-olympics-style-guide/feed/ Is printed documentation dead? http://writerriver.com/2008/08/05/is-printed-documentation-dead/ http://writerriver.com/2008/08/05/is-printed-documentation-dead/#comments Tue, 05 Aug 2008 07:04:25 +0000 shanghaitechwriter http://writerriver.com/2008/08/05/is-printed-documentation-dead/ Is printed documentation dead?

]]> http://writerriver.com/2008/08/05/is-printed-documentation-dead/feed/ 22 things to check before publishing a t … http://writerriver.com/2008/08/05/22-things-to-check-before-publishing-a-t/ http://writerriver.com/2008/08/05/22-things-to-check-before-publishing-a-t/#comments Tue, 05 Aug 2008 07:00:35 +0000 shanghaitechwriter http://writerriver.com/2008/08/05/22-things-to-check-before-publishing-a-t/ 22 things to check before publishing a technical manual

]]> http://writerriver.com/2008/08/05/22-things-to-check-before-publishing-a-t/feed/ How I write Help for a topic-based help … http://writerriver.com/2008/08/05/how-i-write-help-for-a-topic-based-help/ http://writerriver.com/2008/08/05/how-i-write-help-for-a-topic-based-help/#comments Tue, 05 Aug 2008 06:59:42 +0000 shanghaitechwriter http://writerriver.com/2008/08/05/how-i-write-help-for-a-topic-based-help/ How I write Help for a topic-based help system

]]> http://writerriver.com/2008/08/05/how-i-write-help-for-a-topic-based-help/feed/ Community and documentation - what’s the best blend? http://writerriver.com/2008/08/04/community-and-documentation-whats-the-best-blend/ http://writerriver.com/2008/08/04/community-and-documentation-whats-the-best-blend/#comments Mon, 04 Aug 2008 14:33:08 +0000 annegentle http://writerriver.com/?p=91 O’Reilly editor Andy Oram has an excellent article about community-based documentation where he shares his research findings - and it’s not all sugar-coated. Only about half of forum questions are answered correctly, and when a user needs more training or indepth explanations on complex products or configurations, the community can sometimes let them down. Community leaders learn quickly that they can become targets when trying to explain that a task is difficult or complicated. See Educating computer users: the need for community/author collaboration. Find out when documentation deserves further polishing. Excellent insights.

]]> http://writerriver.com/2008/08/04/community-and-documentation-whats-the-best-blend/feed/