Re: [smartweb-devel] How organize documentation

[rlogiacco <rlo...@us...>]

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.