: Re: Best Tool to Create User Guides We are planning to create a user guide for internal use only. It's 150-page document in Word for a self-developed SW tool. The user guide will require constant

For internal documentation I've found wikis to be quite useful. A wiki has several useful features for this task:

built-in change-tracking
doc can be structured as several pages (e.g. one per major section) for easier management; individual pages can then be edited without any need to merge changes into a master document
some (most?) wiki platforms detect impending edit conflicts; if someone else has the page open for edit you'll find out (so no messy merges later)
can be accessed by anybody with a browser, on any device (try reading a Word doc or PDF on your phone...)
if your wiki keeps a "recent changes" page, work is visible and thus more likely to receive additional helpful edits or comments (more collaboration)

It does have some disadvantages -- you have to run a server, and printing isn't very practical. If you ever decided to publish the documentation to a wider audience you'd need to port it to something. But, that said, you could probably script most of that.

Load Full (0)

: This XKCD strip shows a visualization approach for tracking character interactions -- who's with whom when. It works pretty well even with a complex plot with many characters (one of the

@Hamaas631

Load Full 0 Comments

: Common process for creating social media content? I've been tasked with defining a process to write and share content to social media. We are a small company and while we have people that create

@Hamaas631

Load Full 1 Comments

: Write a presentation of a dissertation We have made a dissertation about a type of insect called Pine Processionary Moth. We have applied some statistical methods on it: data analysis and cluster

@Hamaas631

Load Full 0 Comments

: How do I cover a lengthy time period with only a few interesting details? I'm writing a book about my three weeks of travel in Belize (is that even enough time for a book?), and I'm wondering

: Re: Best Tool to Create User Guides We are planning to create a user guide for internal use only. It's 150-page document in Word for a self-developed SW tool. The user guide will require constant

More posts by @Hamaas631

: This XKCD strip shows a visualization approach for tracking character interactions -- who's with whom when. It works pretty well even with a complex plot with many characters (one of the

: Common process for creating social media content? I've been tasked with defining a process to write and share content to social media. We are a small company and while we have people that create

: Write a presentation of a dissertation We have made a dissertation about a type of insect called Pine Processionary Moth. We have applied some statistical methods on it: data analysis and cluster

: How do I cover a lengthy time period with only a few interesting details? I'm writing a book about my three weeks of travel in Belize (is that even enough time for a book?), and I'm wondering

Login to post a comment!

0 Comments

Back to top