Thread: [smartweb-devel] How organize documentation
Brought to you by:
rlogiacco
Menu
▾
▴
smartweb-devel
|
From: amarini <ann...@gm...> - 2007-07-09 20:47:09
|
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=E2=80=99s manual should be splitted up for the several tier, follo= wing 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 cove= r also JUnit=E2=80=99s tests realization.=20 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.=20 The guide to the configuration instead should be something much specific referred to configuration=E2=80=99s files(currently they are only copies of= external configuration=E2=80=99s files=E2=80=A6.). 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=E2=80=99s manual and in the study case). --=20 View this message in context: http://www.nabble.com/How-organize-documentat= ion-tf4051907s17546.html#a11509452 Sent from the SmartWeb Developers mailing list archive at Nabble.com. |
|
From: rlogiacco <rlo...@us...> - 2007-07-31 13:16:50
|
Agreed! :handshake: Do you think you can start reorganizing the documentation site? I'll provid= e you any support you can need... :-) amarini wrote: >=20 > Here some guide lines to organize the documentation. >=20 > In the first page we should explain who can draw utility by using SmartWe= b > 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. >=20 > The user=E2=80=99s manual should be splitted up for the several tier, fol= lowing > 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=E2=80=99s tests realization.=20 >=20 > Side by side we should produce a tutorial that could guide step to step i= n > 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 ho= w > made tests.=20 >=20 > The guide to the configuration instead should be something much specific > referred to configuration=E2=80=99s files(currently they are only copies = of > external configuration=E2=80=99s files=E2=80=A6.). >=20 > 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=E2=80=99s manual and in the study case). >=20 >=20 --=20 View this message in context: http://www.nabble.com/How-organize-documentat= ion-tf4051907s17546.html#a11923795 Sent from the SmartWeb Developers mailing list archive at Nabble.com. |
|
From: amarini <ann...@gm...> - 2007-08-06 08:05:15
|
I think I can start...I'll surely need your support, I'll let you know... thanks :-) rlogiacco wrote: >=20 > Agreed! :handshake: >=20 > Do you think you can start reorganizing the documentation site? I'll > provide you any support you can need... :-) >=20 >=20 > amarini wrote: >>=20 >> Here some guide lines to organize the documentation. >>=20 >> 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 problemati= c >> it tries to resolve and in what way. >>=20 >> The user=E2=80=99s manual should be splitted up for the several tier, fo= llowing >> 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=E2=80=99s tests realization.=20 >>=20 >> 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 demonstrat= e >> the different phases of a project, like how made the analysis when and >> how made tests.=20 >>=20 >> The guide to the configuration instead should be something much specific >> referred to configuration=E2=80=99s files(currently they are only copies= of >> external configuration=E2=80=99s files=E2=80=A6.). >>=20 >> 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=E2=80=99s manual and in the study case)= . >>=20 >>=20 >=20 >=20 --=20 View this message in context: http://www.nabble.com/How-organize-documentat= ion-tf4051907s17546.html#a12012438 Sent from the SmartWeb Developers mailing list archive at Nabble.com. |
|
From: amarini <ann...@gm...> - 2007-09-13 11:17:41
|
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=20 amarini wrote: >=20 > I think I can start...I'll surely need your support, I'll let you know... > thanks :-) >=20 >=20 > rlogiacco wrote: >>=20 >> Agreed! :handshake: >>=20 >> Do you think you can start reorganizing the documentation site? I'll >> provide you any support you can need... :-) >>=20 >>=20 >> amarini wrote: >>>=20 >>> Here some guide lines to organize the documentation. >>>=20 >>> 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. >>>=20 >>> The user=E2=80=99s manual should be splitted up for the several tier, f= ollowing >>> 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=E2=80=99s tests realization.=20 >>>=20 >>> 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 b= e >>> 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.=20 >>>=20 >>> The guide to the configuration instead should be something much specifi= c >>> referred to configuration=E2=80=99s files(currently they are only copie= s of >>> external configuration=E2=80=99s files=E2=80=A6.). >>>=20 >>> 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=E2=80=99s manual and in the study case= ). >>>=20 >>>=20 >>=20 >>=20 >=20 >=20 --=20 View this message in context: http://www.nabble.com/How-organize-documentat= ion-tf4051907s17546.html#a12652821 Sent from the SmartWeb Developers mailing list archive at Nabble.com. |
|
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 > |
|
From: rlogiacco <rlo...@us...> - 2007-09-13 17:20:47
|
I think your work is very good :clap::handshake::clap: I'm only concerned about the detail level:confused: Do you think this can b= e the home page? I'm not really sure: all this infos on the first page may overwelm a first-time visitor... %-| What about splitting this into two pages: a lesser detailed one as home pag= e and a second one with more detail? Anyway I promise I'll help you with your SVN problems on first occasion..... so don't forget your notebook this weekend :-P amarini wrote: >=20 > 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... >=20 > Just tell me if you agree or not on my laying. So I'll go on :working: in > that way... > Thanks >=20 > http://www.nabble.com/file/p12652821/Home.apt Home.apt=20 >=20 >=20 > amarini wrote: >>=20 >> I think I can start...I'll surely need your support, I'll let you know..= . >> thanks :-) >>=20 >>=20 >> rlogiacco wrote: >>>=20 >>> Agreed! :handshake: >>>=20 >>> Do you think you can start reorganizing the documentation site? I'll >>> provide you any support you can need... :-) >>>=20 >>>=20 >>> amarini wrote: >>>>=20 >>>> Here some guide lines to organize the documentation. >>>>=20 >>>> 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. >>>>=20 >>>> The user=E2=80=99s manual should be splitted up for the several tier, = following >>>> the suggestion that we give, to separate the tasks, for tier. For ever= y >>>> 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. Thi= s >>>> manual should cover also JUnit=E2=80=99s tests realization.=20 >>>>=20 >>>> Side by side we should produce a tutorial that could guide step to ste= p >>>> 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.=20 >>>>=20 >>>> The guide to the configuration instead should be something much >>>> specific referred to configuration=E2=80=99s files(currently they are = only >>>> copies of external configuration=E2=80=99s files=E2=80=A6.). >>>>=20 >>>> 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=E2=80=99s manual and in the study cas= e). >>>>=20 >>>>=20 >>>=20 >>>=20 >>=20 >>=20 >=20 >=20 --=20 View this message in context: http://www.nabble.com/How-organize-documentat= ion-tf4051907s17546.html#a12659565 Sent from the SmartWeb Developers mailing list archive at Nabble.com. |
|
From: rlogiacco <rlo...@us...> - 2007-09-27 14:37:03
|
Have you any update on the documentation? We are still waiting your last revision, as discussed in our last meeting, for inclusion... amarini wrote: >=20 > 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... >=20 > Just tell me if you agree or not on my laying. So I'll go on :working: in > that way... > Thanks >=20 > http://www.nabble.com/file/p12652821/Home.apt Home.apt=20 >=20 >=20 > amarini wrote: >>=20 >> I think I can start...I'll surely need your support, I'll let you know..= . >> thanks :-) >>=20 >>=20 >> rlogiacco wrote: >>>=20 >>> Agreed! :handshake: >>>=20 >>> Do you think you can start reorganizing the documentation site? I'll >>> provide you any support you can need... :-) >>>=20 >>>=20 >>> amarini wrote: >>>>=20 >>>> Here some guide lines to organize the documentation. >>>>=20 >>>> 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. >>>>=20 >>>> The user=E2=80=99s manual should be splitted up for the several tier, = following >>>> the suggestion that we give, to separate the tasks, for tier. For ever= y >>>> 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. Thi= s >>>> manual should cover also JUnit=E2=80=99s tests realization.=20 >>>>=20 >>>> Side by side we should produce a tutorial that could guide step to ste= p >>>> 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.=20 >>>>=20 >>>> The guide to the configuration instead should be something much >>>> specific referred to configuration=E2=80=99s files(currently they are = only >>>> copies of external configuration=E2=80=99s files=E2=80=A6.). >>>>=20 >>>> 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=E2=80=99s manual and in the study cas= e). >>>>=20 >>>>=20 >>>=20 >>>=20 >>=20 >>=20 >=20 >=20 --=20 View this message in context: http://www.nabble.com/How-organize-documentat= ion-tf4051907s17546.html#a12922674 Sent from the SmartWeb Developers mailing list archive at Nabble.com. |
×
Want the latest updates on software, tech news, and AI?
Get latest updates about software, tech news, and AI from SourceForge directly in your inbox once a month.
Thanks for helping keep SourceForge clean.
X