473,779 Members | 2,058 Online
Bytes | Software Development & Data Engineering Community
+ Post

Home Posts Topics Members FAQ

Any suggestions for a help system?

I am developing a CMS/web-building website, and I need to include a
good help system to help my customers learn how to use the features of
what my project offers. Does anyone have suggestions about what help
products I could incorporate into my site?

I want the standard outline system, with a column showing chapters, an
index, and search box.

Any leads will be greatly appreciated.
Apr 21 '06 #1
3 1500
In article <ik************ *************** *****@4ax.com>,
firewood <fi******@ironw ork.com> wrote:
I am developing a CMS/web-building website, and I need to include a
good help system to help my customers learn how to use the features of
what my project offers.
The best help system is the one that isn't needed. While it is likely
that you'll need to offer *some* help/documentation, don't be the
zilionth developer to use documentation as an excuse to not aim for a
self-explanatory UI.

I realise that's not what you asked for and I realise it's not easy to
achieve. But I do think it's the only 'right' goal to aim for.

[...]
I want the standard outline system, with a column showing chapters, an
index, and search box.
Searchability is good to offer, but only if it produces relevant
results. Too often such systems are in practice useless. Personally I
prefer contextual help: provide a mechanism that offers help relating to
the current context, whatever it is.
Any leads will be greatly appreciated


HTH

--
Sander Tekelenburg, <http://www.euronet.nl/~tekelenb/>

Mac user: "Macs only have 40 viruses, tops!"
PC user: "SEE! Not even the virus writers support Macs!"
Apr 22 '06 #2
Strony internetowe http://www.czajawebhosting.info
Szanowni Panstwo nasza firma to zespól molodych i preznych
specjalistów z wieloletnim doswiadczeniem w zakresie technologii
internetwej. Oferujemy szeroki zakres uslug, poczawszy od prostych
statycznych stron www na rozbudowanych aplikacjach skonczywszy.
Cechuje nas innowacyjnosc wysoka jakosc swiadczonych uslug oraz
solidnosc i terminowosc wykonania prac.

Apr 22 '06 #3
I agree with Sander, but I would add something. You can use tooltips to
help provide context help, domTT is our preferred javascript library
for such tooltips. If you want to do a bug manualy becasue your system
does require it then I would suggest looking at DocBook which is a
format that makes converting into pdfs, html, etc relatively easy.

Having said that I do like the documents that allow comments (like the
php manual).

Apr 24 '06 #4

This thread has been closed and replies have been disabled. Please start a new discussion.

Similar topics

17
8296
by: Phil Powell | last post by:
Where can I find an online PHP form validator script library to use? I have tried hacking the one here at work for weeks now and it's getting more and more impossible to customize, especially now with form elements that turn out to be arrays that have to be compared with one another! I have one form element, languages, a checkbox group. Beside each checkbox is a dropdown, proficiency (which will become proficiency alongside languages)....
6
2206
by: JW | last post by:
I'm displaying product thumbnails with brief descriptions on web pages. Clicking on the product does a javascript popup with larger image and detailed description info passed to the javascript functions from the table data. Products can change frequently, and I want to make the maintenance of this info easier by non-techies (each product has an image name, image width (currently not using getimagesize), a short description, and a long...
10
1302
by: Aditi | last post by:
hi all...i m a software engg. student completed my 2nd yr...i have been asked to make a project during these summer vacations...and hereby i would like to invite some ideas bout the design and implementation of an APPLICATION MONITORING SYSTEM....i have to start from scrach so please tell me how to go bout it rite from the beggining this is the first time i m making a project of this complexity... i have to make a system used by the IT...
0
1286
by: Matt W | last post by:
Hi all, I'm planning to use MySQL's full-text search for my forum system (possibly 5+ million posts). I've been playing with it a lot lately to see the performance and functionality and have some suggestions/questions. First, since a few of you may be wanting to know, here is a thread where I was doing some speed/optimization tests and stuff with 3 million posts: http://www.sitepointforums.com/showthread.php?threadid=69555
6
1961
by: Me | last post by:
I am looking for some suggestions or sample code for an application the sits in the system tray (a TSR) and then executes code that I specify when a certain executable is launched. As an example, an TSR that pops a Dialog Box up in the middle of the screen when winword.exe is launched. Any ideas, John
0
867
by: Michael | last post by:
Hi Everyone, I'm in the process of designing a app that will load control dynamically from an xml file and need a few questions. 1. Once the form is loaded with the controls needed, how do you access the properties of the control. I just started to play with it today, and noticed that I can't seem to get the values from the controls. Here is the code snippit that I'm using: Dim btnOk as New System.Windows.Forms.Button btnok.Name =...
1
1310
by: d4v3y0rk | last post by:
i have a class i found/wrote (meaning i found it originally and tinkered with it to make it mine) and i would like some suggestions on how to make it better. i am looking for things i need to add, weaknesses, whatnot. Thanks in advance. ----------------------------------------------------------------------------------------------------------------- Imports System.Security.Cryptography Imports System.Security Imports System.Text
45
3463
by: Gregory Petrosyan | last post by:
1) From 2.4.2 documentation: There are two new valid (semantic) forms for the raise statement: raise Class, instance raise instance 2) In python: >>> raise NameError Traceback (most recent call last): File "<stdin>", line 1, in ? NameError
6
1538
by: cbmeeks | last post by:
I am writing YAPSS (Yet Another Photo Sharing Site). Currently, the user can upload up to six pictures at once. When the uploads are complete, I then have a script that will resize the pix to different thumbnails for speed. However, imagine resizing 6 pictures of 2300x2200 pixels in 6 different sizes (maintaining the best quality I can) on a Pentium 3 450Mhz running Ubuntu and 384 megs of ram. Seriously.
0
9474
by: Hystou | last post by:
Most computers default to English, but sometimes we require a different language, especially when relocating. Forgot to request a specific language before your computer shipped? No problem! You can effortlessly switch the default language on Windows 10 without reinstalling. I'll walk you through it. First, let's disable language synchronization. With a Microsoft account, language settings sync across devices. To prevent any complications,...
0
10306
Oralloy
by: Oralloy | last post by:
Hello folks, I am unable to find appropriate documentation on the type promotion of bit-fields when using the generalised comparison operator "<=>". The problem is that using the GNU compilers, it seems that the internal comparison operator "<=>" tries to promote arguments from unsigned to signed. This is as boiled down as I can make it. Here is my compilation command: g++-12 -std=c++20 -Wnarrowing bit_field.cpp Here is the code in...
0
9930
tracyyun
by: tracyyun | last post by:
Dear forum friends, With the development of smart home technology, a variety of wireless communication protocols have appeared on the market, such as Zigbee, Z-Wave, Wi-Fi, Bluetooth, etc. Each protocol has its own unique characteristics and advantages, but as a user who is planning to build a smart home system, I am a bit confused by the choice of these technologies. I'm particularly interested in Zigbee because I've heard it does some...
0
8961
agi2029
by: agi2029 | last post by:
Let's talk about the concept of autonomous AI software engineers and no-code agents. These AIs are designed to manage the entire lifecycle of a software development project—planning, coding, testing, and deployment—without human intervention. Imagine an AI that can take a project description, break it down, write the code, debug it, and then launch it, all on its own.... Now, this would greatly impact the work of software developers. The idea...
1
7485
isladogs
by: isladogs | last post by:
The next Access Europe User Group meeting will be on Wednesday 1 May 2024 starting at 18:00 UK time (6PM UTC+1) and finishing by 19:30 (7.30PM). In this session, we are pleased to welcome a new presenter, Adolph Dupré who will be discussing some powerful techniques for using class modules. He will explain when you may want to use classes instead of User Defined Types (UDT). For example, to manage the data in unbound forms. Adolph will...
0
6724
by: conductexam | last post by:
I have .net C# application in which I am extracting data from word file and save it in database particularly. To store word all data as it is I am converting the whole word file firstly in HTML and then checking html paragraph one by one. At the time of converting from word file to html my equations which are in the word document file was convert into image. Globals.ThisAddIn.Application.ActiveDocument.Select();...
1
4037
by: 6302768590 | last post by:
Hai team i want code for transfer the data from one system to another through IP address by using C# our system has to for every 5mins then we have to update the data what the data is updated we have to send another system
2
3632
muto222
by: muto222 | last post by:
How can i add a mobile payment intergratation into php mysql website.
3
2869
bsmnconsultancy
by: bsmnconsultancy | last post by:
In today's digital era, a well-designed website is crucial for businesses looking to succeed. Whether you're a small business owner or a large corporation in Toronto, having a strong online presence can significantly impact your brand's success. BSMN Consultancy, a leader in Website Development in Toronto offers valuable insights into creating effective websites that not only look great but also perform exceptionally well. In this comprehensive...

By using Bytes.com and it's services, you agree to our Privacy Policy and Terms of Use.

To disable or enable advertisements and analytics tracking please visit the manage ads & tracking page.