In page help/documentation?

You have a suggestion for a future version of phpMyFAQ? Then post it here!

Moderator: Thorsten

Post Reply
clemens
Posts: 1
Joined: Fri Feb 25, 2011 10:56 am

In page help/documentation?

Post by clemens » Fri Feb 25, 2011 11:16 am

Hello,

this is just an idea of what I have found extremely useful when I had to deal with the web-based continuous integration system Hudson (Jenkins, these days) in the past:

They have all the pieces of information that you usually have in a manual in every page, exactly where you are interested in it.

In most cases the information is hidden and clicking the round help button toggle between the information being visible or hidden.

I took some simple screenshots of this:

Image

Image

Another good point about this approach is that you see what is not documented while using the software. If you have a separate manual careful list keeping and manually matching what is in the user interface and what is in the manual must be done.



Kind regards

Clemens Anhuth

Post Reply