U++ forum: Welcome to the forum

Status & Roadmap

Authors & License

Funding Ultimate++

Search on this site

Search in forums

Home » Developing U++ » U++ Developers corner » Documentation and Topic++

Show: Today's Messages :: Show Polls :: Message Navigator
E-mail to friend

Return to the default flat view

Create a new topic

Submit Reply

Re: Documentation and Topic++ [message #12720 is a reply to message #12713]

Wed, 14 November 2007 04:32

Mindtraveller is currently offline

Mindtraveller
Messages: 917
Registered: August 2007
Location: Russia, Moscow rgn.

Experienced Contributor

I think this is of course great to have one help engine for development docs and user (not programmer) documentation on application developed. So I vote for the original idea.

Next, from the design point of view, treeview-control guiding system as well as "predefined groups" seems to me not very optimal.

I`ll try to make suggestions how to increase usability. Of course, everything below is my point of view and a subject for discussion:

1) Leving behind any "magical words" line "srcdocs","srcimp". We simply don`t need that kind of magic. We need simple things to concentrate attention to the help text itself - without user`s brain guiding through magical labyrinths.

2) Information on package must be concentrated in one articles-tree. Each article has index-tags. So user has 3 ways to look at docs: manual view mode, index and full-text-search modes. Last two modes I`d like to be as MSDN ones.

This approach seems to me little more general. General enough to handle with programmers` manual as easy as user help.

3) src* groups are presented as:
src - number of articles, generated by TheIDE (and linked from some other articles if necessary). I`d prefer some package article to have these links listed by logical or functional groups (alphabetic access is available through Index mode).

srcimp and srcdoc articles are represented as links from (or part of) articles about respective subjects.
The general approach is the same: different kinds of information about subject must be in easy reach from parent article about subject. It seems very obvious way of making things user-oriented.

4) Fimally, general view of help system with approach suggested will be something like this:
index.php?t=getfile&id=832&private=0

index.php?t=getfile&id=832&private=0

5) Thoughts about root article I`ll try to write later, as all ideas about it come in order.

Attachment: Untitled-1.gif
(Size: 47.45KB, Downloaded 1290 times)

[Updated on: Wed, 14 November 2007 04:35]

Report message to a moderator

Send a private message to this user

[Message index]

		Documentation and Topic++ By: mirek on Tue, 13 November 2007 19:41
		Re: Documentation and Topic++ By: Mindtraveller on Wed, 14 November 2007 04:32
		Re: Documentation and Topic++ By: mirek on Wed, 14 November 2007 11:46
		Re: Documentation and Topic++ By: Mindtraveller on Wed, 14 November 2007 13:24
		Re: Documentation and Topic++ By: mirek on Wed, 14 November 2007 13:41
		Re: Documentation and Topic++ By: Mindtraveller on Fri, 16 November 2007 01:36
		Re: Documentation and Topic++ By: Mindtraveller on Fri, 16 November 2007 01:37
		Re: Documentation and Topic++ By: Mindtraveller on Fri, 16 November 2007 01:40
		Re: Documentation and Topic++ By: Mindtraveller on Fri, 16 November 2007 01:42
		Re: Documentation and Topic++ By: Mindtraveller on Fri, 16 November 2007 01:54
		Re: Documentation and Topic++ By: mirek on Fri, 16 November 2007 12:05
		Re: Documentation and Topic++ By: Mindtraveller on Tue, 04 December 2007 16:21
		Re: Documentation and Topic++ By: mirek on Tue, 04 December 2007 17:10
		Re: Documentation and Topic++ By: Mindtraveller on Tue, 04 December 2007 19:25
		Re: Documentation and Topic++ By: mirek on Tue, 04 December 2007 23:32
		Re: Documentation and Topic++ By: Mindtraveller on Wed, 05 December 2007 18:19
		Re: Documentation and Topic++ By: mirek on Wed, 05 December 2007 19:18
		Re: Documentation and Topic++ By: Novo on Thu, 06 December 2007 20:05
		Re: Documentation and Topic++ By: zsolt on Thu, 06 December 2007 21:05
		Re: Documentation and Topic++ By: mirek on Thu, 06 December 2007 21:10
		Re: Documentation and Topic++ By: Novo on Thu, 06 December 2007 21:49
		Re: Documentation and Topic++ By: Mindtraveller on Wed, 12 December 2007 23:20
		Re: Documentation and Topic++ By: mirek on Thu, 13 December 2007 18:27
		Re: Documentation and Topic++ By: Mindtraveller on Fri, 14 December 2007 05:57
		Re: Documentation and Topic++ By: mirek on Fri, 14 December 2007 17:17
		Re: Documentation and Topic++ By: mrjt on Mon, 14 April 2008 11:27
		Re: Documentation and Topic++ By: mirek on Mon, 14 April 2008 14:26
		Re: Documentation and Topic++ By: mrjt on Mon, 14 April 2008 14:40
		Re: Documentation and Topic++ By: cbpporter on Tue, 10 June 2008 17:13
		Re: Documentation and Topic++ By: mirek on Tue, 10 June 2008 18:35
		Re: Documentation and Topic++ By: cbpporter on Thu, 12 June 2008 13:02
		Re: Documentation and Topic++ By: mirek on Thu, 12 June 2008 17:36
		Re: Documentation and Topic++ By: zsolt on Thu, 12 June 2008 20:25
		Re: Documentation and Topic++ By: cbpporter on Thu, 12 June 2008 22:46
		Re: Documentation and Topic++ By: mrjt on Thu, 12 June 2008 23:35
		Re: Documentation and Topic++ By: mirek on Fri, 13 June 2008 09:36
		Re: Documentation and Topic++ By: mirek on Fri, 13 June 2008 09:45
		Re: Documentation and Topic++ By: Mindtraveller on Sun, 15 June 2008 14:59
		Re: Documentation and Topic++ By: mdelfede on Sun, 15 June 2008 19:03
		Re: Documentation and Topic++ By: Mindtraveller on Sun, 15 June 2008 21:26
		Re: Documentation and Topic++ By: mirek on Mon, 16 June 2008 13:00
		Re: Documentation and Topic++ By: mdelfede on Mon, 16 June 2008 13:58
		Re: Documentation and Topic++ By: mirek on Mon, 16 June 2008 15:34
		Re: Documentation and Topic++ By: cbpporter on Mon, 16 June 2008 17:21
		Re: Documentation and Topic++ By: mirek on Mon, 16 June 2008 19:38
		Re: Documentation and Topic++ By: cbpporter on Wed, 18 June 2008 10:30
		Re: Documentation and Topic++ By: mirek on Wed, 18 June 2008 11:23
		Re: Documentation and Topic++ By: mr_ped on Wed, 18 June 2008 11:39
		Re: Documentation and Topic++ By: Mindtraveller on Mon, 16 June 2008 20:48
		Re: Documentation and Topic++ By: mirek on Mon, 16 June 2008 20:54
		Re: Documentation and Topic++ By: mdelfede on Mon, 16 June 2008 23:12
		Re: Documentation and Topic++ By: mirek on Tue, 17 June 2008 00:55
		Re: Documentation and Topic++ By: mdelfede on Tue, 17 June 2008 01:02
		Re: Documentation and Topic++ By: Mindtraveller on Wed, 18 June 2008 09:16
		Re: Documentation and Topic++ By: mdelfede on Wed, 18 June 2008 09:55
		Re: Documentation and Topic++ By: mirek on Wed, 18 June 2008 11:20
		Re: Documentation and Topic++ By: mdelfede on Wed, 18 June 2008 12:05
		Re: Documentation and Topic++ By: mirek on Wed, 18 June 2008 13:22
		Re: Documentation and Topic++ By: Mindtraveller on Wed, 18 June 2008 14:42
		Re: Documentation and Topic++ By: mdelfede on Wed, 18 June 2008 16:29
		Re: Documentation and Topic++ By: mirek on Wed, 18 June 2008 17:43
		Re: Documentation and Topic++ By: Mindtraveller on Thu, 19 June 2008 13:26
		Re: Documentation and Topic++ By: mirek on Thu, 19 June 2008 15:00
		Re: Documentation and Topic++ By: Mindtraveller on Sun, 06 July 2008 09:45
		Re: Documentation and Topic++ By: mirek on Sun, 06 July 2008 20:06
		Re: Documentation and Topic++ By: captainc on Mon, 07 July 2008 19:37
		Re: Documentation and Topic++ By: mirek on Mon, 07 July 2008 22:15
		Re: Documentation and Topic++ By: captainc on Tue, 08 July 2008 14:06
		Re: Documentation and Topic++ By: mirek on Tue, 08 July 2008 16:11
		Re: Documentation and Topic++ By: mirek on Tue, 08 July 2008 18:11
		Re: Documentation and Topic++ By: mr_ped on Tue, 17 June 2008 11:59
		Re: Documentation and Topic++ By: mirek on Tue, 17 June 2008 13:40

Previous Topic:	Task: How to read GTK/Gnome settings
Next Topic:	U++ infrastructure server...

Goto Forum:

-=] Back to Top [=-

[ Syndicate this forum (XML) ] [

] [

PDF

]

Current Time: Mon May 13 11:31:49 CEST 2024

Total time taken to generate the page: 0.02695 seconds