Re: [mv] more documentation stuff (fwd)

[Stefan Hornburg <racke@linuxia.de>]

******    message to minivend-users from Stefan Hornburg <racke@linuxia.de>     ******

Sonny Cook <sonny@akopia.com> writes:


[...]

> 
> It seems that there was a big call for improved (completed) handychange
> tag reference.  With complete explanations, parameters, anotations,
> dependencies, caveats, and even previously undocumented features.  This is
> a rather herculean task--which will not appear in the next release.  We
> will work on this, however, do not despare.  One point that a couple of
> folks mentioned that I failed to appreciate was the need for CLEAR
> language usage.  In my Americanocentric bubble it completely failed to
> occur to me that others cannot speak englich as poorly as I can, and so my
> tendancy to create complex (and sometimes esoteric and subtle) grammatical
> towers--a virtual babel so to speak--would be less than appreciated by
> others, and therefore I shall forebear.  Good point.

>From a general point of view, documentation written by Americans is
far better readable than German ones, so go ahead.

> 
> Examples--lots and with explanations.
> 
> More accessible organization of the present documentation which can be
> annotated.

Indices !!

> 
> Your comments have helped me clear up my vision quite a bit.  Here is a
> summary of what I hope you can expext with the next release.
> 
> Some basic stuff:
> 	how to install intervend
> 	how to configure the demo store
> 	run though of the demo store
> Less basic stuff:
> 	overview of the minichange system
> 	annotated templates (different from the demo store)
> 	really good explanations of the various configuration files
> 	how-tos for various and sundry things people may wish to do
> Not basic stuff:
> 	indexed searchable tag reference which will be annotatable
> 	improving the tag reference
> 	Walkthrough for creating a new intervend site implementation from
> scratch.
> 	improved organization and accuracy of current documentation

Documentation of the UI stuff, which is nearly covered at all by now.

Which are your plans in respect to the source format of the documentation ?

Ciao
        Racke

-- 
LinuXia Systems && Cobolt NetServices, eCommerce and more
Shop- und Datenbanklösungen mit MiniVend, Firewalls auf Debian-Basis
http://www.linuxia.de - http://www.cobolt.net
--> Coding from hell and back <--- 
-
To unsubscribe from the list, DO NOT REPLY to this message.  Instead, send
email with 'UNSUBSCRIBE minivend-users' in the body to Majordomo@minivend.com.
Archive of past messages: http://www.minivend.com/minivend/minivend-list