[smartweb-devel] How organize documentation

[amarini <ann...@gm...>]

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.