rickardlindberg

A new help system

In Timeline on September 9, 2009 at 6:59 PM

The last couple of days I have been working on a new help system for Timeline. Instead of having a single user manual document which is hard to navigate, the new help system is more like a wiki with many small pages covering specific topics. All pages can also link to related pages. This approach has some advantages over a singe user manual document:

  • It is easier to write a help page about a topic because you do not need to figure out where in the manual to put it or be concerned that it will not fit the structure of the manual
  • It is easier for translators to translate a short isolated page instead of a long manual
  • It is easier for users to find information because you can organize the pages in any way you want: popular help topics can be linked to on the first page for example

The new help system is available in the development repository now and will appear in the 0.5.0 release scheduled for October 1, 2009. I believe it will make working with help easier for everyone.

Advertisements

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s

%d bloggers like this: