I wish to try to solve the documentation problem afflicting this project
and I need your support both for decisions and for production.
First of all we have to choose a documentation method between Wiki and
Maven generated pages. I wish to know your opinions and I want to call a
vote about this: +1 means you think Wiki is better, -1 you think Maven
is better, 0 you don't have an opinion or you can't decide between them.
We need to establish the user manual structure and I think Annamaria
idea is good, I'm going to repost it here in it's simpler version and
explain the contents:
- overview
we present the framework, the objectives, the architectural and
structural overview including when and why to use it
- quick start
the minimal, step-by-step instructions to start working with the
framework and buil your first simple HelloWorld application
- guided tour
a fully comprehensive guide throughout the framework, from the business
model to the persistence tier raising to the presentation tier so we can
depict in the tour a good practice in using the framework itself
- how to
a collection of how to perform some specific tasks, like how to use two
databases, how to write unit tests, how to use modules and so on
- problems resolution
a collection of common errors and their resolution
Each module will have it's own documentation with the same structure but
with contents constrained to the the module.
--
Roberto Lo Giacco
Chief Technical Officer
SmartLab s.r.l.
via Spagna, snc - 87036 Rende (CS) - Italy
Mobile: +39 392 8765657
Email: rlo...@sm...
Skype: longisland-75
Web: http://www.smartlab.it
|
