Re: [smartweb-devel] How organize documentation
Brought to you by:
rlogiacco
From: Stefano V <st...@gm...> - 2007-09-13 16:05:10
|
I think the work is good. No, Let's go on! :-) 2007/9/13, amarini <ann...@gm...>: > > > Here I am, take a look to the attached file concerning SmartWeb HomePage, > it's just a first drawing up, I surely have to more itemize the > authorization, authentication and auditing exposition and add the > pertinent > link... > > Just tell me if you agree or not on my laying. So I'll go on :working: in > that way... > Thanks > > http://www.nabble.com/file/p12652821/Home.apt Home.apt > > > amarini wrote: > > > > I think I can start...I'll surely need your support, I'll let you > know... > > thanks :-) > > > > > > rlogiacco wrote: > >> > >> Agreed! :handshake: > >> > >> Do you think you can start reorganizing the documentation site? I'll > >> provide you any support you can need... :-) > >> > >> > >> amarini wrote: > >>> > >>> Here some guide lines to organize the documentation. > >>> > >>> In the first page we should explain who can draw utility by using > >>> SmartWeb running from the typology of applications for which it is > >>> recommended, in what it differs from others OpenSource, which > >>> problematic it tries to resolve and in what way. > >>> > >>> The user's manual should be splitted up for the several tier, > following > >>> the suggestion that we give, to separate the tasks, for tier. For > every > >>> tier we should describe how the interaction with the adjacent tier > >>> happens, which are the tools that we put on hand and how use them. > This > >>> manual should cover also JUnit's tests realization. > >>> > >>> Side by side we should produce a tutorial that could guide step to > step > >>> in the realization of a web application (e-commerce web site seems to > be > >>> a tempting example). It could also be used inside in order to > >>> demonstrate the different phases of a project, like how made the > >>> analysis when and how made tests. > >>> > >>> The guide to the configuration instead should be something much > specific > >>> referred to configuration's files(currently they are only copies of > >>> external configuration's files=85.). > >>> > >>> In this viewpoint the architecture, that at the moment is one of main > >>> documents, should become a secondary document recalled from other > >>> documents (in the home, the user's manual and in the study case). > >>> > >>> > >> > >> > > > > > > -- > View this message in context: > http://www.nabble.com/How-organize-documentation-tf4051907s17546.html#a12= 652821 > Sent from the SmartWeb Developers mailing list archive at Nabble.com. > > > ------------------------------------------------------------------------- > This SF.net email is sponsored by: Microsoft > Defy all challenges. Microsoft(R) Visual Studio 2005. > http://clk.atdmt.com/MRT/go/vse0120000070mrt/direct/01/ > _______________________________________________ > smartweb-devel mailing list > sma...@li... > https://lists.sourceforge.net/lists/listinfo/smartweb-devel > |