Comments on: Using Wikis as Project Documentation Tools http://www.idratherbewriting.com/2007/02/03/using-wikis-as-project-documentation-tools/ Technical Communication Blog / Technical Writing Blog Mon, 22 Mar 2010 00:34:43 +0000 http://wordpress.org/?v=2.9.2 hourly 1 By: The Content Wrangler » Blog Archive » Using Wikis as Project Documentation Tools http://www.idratherbewriting.com/2007/02/03/using-wikis-as-project-documentation-tools/comment-page-1/#comment-148466 The Content Wrangler » Blog Archive » Using Wikis as Project Documentation Tools Sat, 13 Feb 2010 23:19:19 +0000 http://www.idratherbewriting.com/2007/02/03/using-wikis-as-project-documentation-tools/#comment-148466 [...] I’d Rather Be Writing, Tom Johnson explores Using Wikis as Project Documentation Tools. In this posting Johnson chats with technical writer Charles Arnold who explains why he’s [...] [...] I’d Rather Be Writing, Tom Johnson explores Using Wikis as Project Documentation Tools. In this posting Johnson chats with technical writer Charles Arnold who explains why he’s [...]

]]> By: Jason Shao http://www.idratherbewriting.com/2007/02/03/using-wikis-as-project-documentation-tools/comment-page-1/#comment-141787 Jason Shao Mon, 29 Jun 2009 02:11:12 +0000 http://www.idratherbewriting.com/2007/02/03/using-wikis-as-project-documentation-tools/#comment-141787 Curious as to how people have worked out on this front. I love using wikis for docs, since they greatly lower the barrier to entry (and, erm, we need that to be looooow to make sure there *are* docs) though I struggle with how to fit versioning that into the SDLC along with our other artifacts - which makes me really like the idea of Maven sites, since the (java-centric) way we release programs would fit well. What does everyone think? How do you tie wiki docs with projects if they're not versioned together. Curious as to how people have worked out on this front. I love using wikis for docs, since they greatly lower the barrier to entry (and, erm, we need that to be looooow to make sure there *are* docs) though I struggle with how to fit versioning that into the SDLC along with our other artifacts – which makes me really like the idea of Maven sites, since the (java-centric) way we release programs would fit well.

What does everyone think? How do you tie wiki docs with projects if they’re not versioned together.

]]> By: Wikis in school projects? : Easy Idiot - get better knowledge http://www.idratherbewriting.com/2007/02/03/using-wikis-as-project-documentation-tools/comment-page-1/#comment-139412 Wikis in school projects? : Easy Idiot - get better knowledge Wed, 15 Apr 2009 06:26:27 +0000 http://www.idratherbewriting.com/2007/02/03/using-wikis-as-project-documentation-tools/#comment-139412 [...] Johnson wrote Using Wikis as Project Documentation Tools two years ago that provides some ideas focused on technical [...] [...] Johnson wrote Using Wikis as Project Documentation Tools two years ago that provides some ideas focused on technical [...]

]]> By: The Content Wrangler http://www.idratherbewriting.com/2007/02/03/using-wikis-as-project-documentation-tools/comment-page-1/#comment-43847 The Content Wrangler Thu, 20 Sep 2007 15:54:30 +0000 http://www.idratherbewriting.com/2007/02/03/using-wikis-as-project-documentation-tools/#comment-43847 <!--%kramer-ref-pre%-->[...] I’d Rather Be Writing, Tom Johnson explores Using Wikis as Project Documentation Tools. In this posting Johnson chats with technical writer Charles Arnold who explains why he’s [...]<!--%kramer-ref-post%--> [...] I’d Rather Be Writing, Tom Johnson explores Using Wikis as Project Documentation Tools. In this posting Johnson chats with technical writer Charles Arnold who explains why he’s [...]

]]> By: Ross Nelson http://www.idratherbewriting.com/2007/02/03/using-wikis-as-project-documentation-tools/comment-page-1/#comment-37921 Ross Nelson Tue, 24 Jul 2007 03:54:15 +0000 http://www.idratherbewriting.com/2007/02/03/using-wikis-as-project-documentation-tools/#comment-37921 Hi tom, similar to using a wiki for project documentation, im currently trying to drum up the concept of using Wiki's for Enterprise Architectures in IT. Basically when u start to explore them, Enterprise Architectures are a set of mulitple semi-structured facts all linked together, just like.... erm... Wikis. With EA by Wiki you wind up with pages about each application, installation, communication link, infrastructure element and standard within an organisation, all easily searchable and accessible and not stuck in some propellor heads brain or only known to the guy who quit last Tuesday. Ive started developing a prototype which can be access from my new blog on the subject at http://eabywiki.blogspot.com/ but it is still early days, and im using a free public online wiki for the demo. The lack of structure can be overcome with easily available good templates (the SP2007 Wiki doesnt really have this but its good in other areas) and a little bit of editorial oversight. Cheers Ross Nelson Hi tom,
similar to using a wiki for project documentation, im currently trying to drum up the concept of using Wiki’s for Enterprise Architectures in IT. Basically when u start to explore them, Enterprise Architectures are a set of mulitple semi-structured facts all linked together, just like…. erm… Wikis. With EA by Wiki you wind up with pages about each application, installation, communication link, infrastructure element and standard within an organisation, all easily searchable and accessible and not stuck in some propellor heads brain or only known to the guy who quit last Tuesday.

Ive started developing a prototype which can be access from my new blog on the subject at http://eabywiki.blogspot.com/ but it is still early days, and im using a free public online wiki for the demo. The lack of structure can be overcome with easily available good templates (the SP2007 Wiki doesnt really have this but its good in other areas) and a little bit of editorial oversight.

Cheers

Ross Nelson

]]> By: Wiki research for an article about tech pubs and wikis « just write click http://www.idratherbewriting.com/2007/02/03/using-wikis-as-project-documentation-tools/comment-page-1/#comment-36640 Wiki research for an article about tech pubs and wikis « just write click Tue, 26 Jun 2007 02:55:28 +0000 http://www.idratherbewriting.com/2007/02/03/using-wikis-as-project-documentation-tools/#comment-36640 [...] of good discussions on wikis for technical documentation from February 2007 on Tom Johnson’s I’d Rather Be Writing Blog as well as The Write Time blog. Tom’s post talks about using wikis to help with the [...] [...] of good discussions on wikis for technical documentation from February 2007 on Tom Johnson’s I’d Rather Be Writing Blog as well as The Write Time blog. Tom’s post talks about using wikis to help with the [...]

]]> By: Lars Trieloff's Weblog http://www.idratherbewriting.com/2007/02/03/using-wikis-as-project-documentation-tools/comment-page-1/#comment-2350 Lars Trieloff's Weblog Wed, 07 Feb 2007 10:42:10 +0000 http://www.idratherbewriting.com/2007/02/03/using-wikis-as-project-documentation-tools/#comment-2350 <strong>My Methodolgy of writing Documentation with Wikis...</strong> Wikis are a hot topic in technical documentation. Adrian Sutton has some interesting remarks why he thinks, Wikis and user-contributed documentation do not lead to high-quality documentation: Creating Great Documentation : First and foremost, if... My Methodolgy of writing Documentation with Wikis…

Wikis are a hot topic in technical documentation. Adrian Sutton has some interesting remarks why he thinks, Wikis and user-contributed documentation do not lead to high-quality documentation: Creating Great Documentation :

First and foremost, if…

]]> By: chris http://www.idratherbewriting.com/2007/02/03/using-wikis-as-project-documentation-tools/comment-page-1/#comment-2342 chris Tue, 06 Feb 2007 12:28:05 +0000 http://www.idratherbewriting.com/2007/02/03/using-wikis-as-project-documentation-tools/#comment-2342 Tom, Anytime :-) Tom,

Anytime :-)

]]> By: Isaac Garcia http://www.idratherbewriting.com/2007/02/03/using-wikis-as-project-documentation-tools/comment-page-1/#comment-2324 Isaac Garcia Mon, 05 Feb 2007 01:37:29 +0000 http://www.idratherbewriting.com/2007/02/03/using-wikis-as-project-documentation-tools/#comment-2324 Tom - as far as my/our web awareness its just rss feeds on certain keyword searches using Google, Google Blog Search, Technorati and Google Alerts. (we use a combination of RSS feeds as well as their various email alerts) The nice thing is that they are all free. Then, its just a matter of managing the RSS feeds - which is easy - we use Central Desktop to share these RSS Feeds for competitive awareness, research and to stay on top of "Central Desktop" and all relative keywords in the blogosphere. This allows our entire company to stay apprised of our markets and conversations about our products, services and our industry. The really nice thing is that this data goes beyond the Blog World now and spans most of 'mainstream media.' Tom – as far as my/our web awareness its just rss feeds on certain keyword searches using Google, Google Blog Search, Technorati and Google Alerts. (we use a combination of RSS feeds as well as their various email alerts)

The nice thing is that they are all free. Then, its just a matter of managing the RSS feeds – which is easy – we use Central Desktop to share these RSS Feeds for competitive awareness, research and to stay on top of “Central Desktop” and all relative keywords in the blogosphere.

This allows our entire company to stay apprised of our markets and conversations about our products, services and our industry.

The really nice thing is that this data goes beyond the Blog World now and spans most of ‘mainstream media.’

]]> By: Tom http://www.idratherbewriting.com/2007/02/03/using-wikis-as-project-documentation-tools/comment-page-1/#comment-2323 Tom Mon, 05 Feb 2007 00:44:20 +0000 http://www.idratherbewriting.com/2007/02/03/using-wikis-as-project-documentation-tools/#comment-2323 Chris, Dude, that is exactly the kind of thing I am looking for. Thank you so much for responding to my post. I will be looking more carefully into this during the week and will probably follow up with some questions. Tom Chris,

Dude, that is exactly the kind of thing I am looking for. Thank you so much for responding to my post. I will be looking more carefully into this during the week and will probably follow up with some questions.

Tom

]]>