Documentation
ManualProposal |
MANUAL ?
Before publishing I think the wiki needs a little bit of organization.
I also think that the wiki as it is should not go public, that we better add our writings here in an organized manual what perhaps should be a html bookmark structure. This ahould be english and if somebody adds translatin they should be available as new manuals. Only my opinion is that this what egw gets a better and nicer face. So the text should not follow below each headline, rather a link to the bookmark
(GO HERE TO THE MANUAL LAYOUT)
João
Q: Accordingly to your proposal, how should we adapt "user's manual" (i.e: what belong to and what doesn't belong) ?
Q: Do we accept documentation redondancy (i.e: chapters content equality in both "admin" and "user" doc) ?
bertrand
Q: Pardon the questions as I am new here...
1) Do you have a development copy of the admin and user manuals so that we can see and update them before we publish to production (web site)? Have I not found it? Do you develop documentation like code:
internal wiki
Dev copy of
documentation
with group
collaboration
|
Approval Process
|
V
external (public web)
Publicly viewed
documentation on
egroupware.org wiki
2) If not, do you object to me making one?
AldoRenwald
02/16/04
I have submitted a proposal for how the documentation process might flow. Please post your comments here (good / bad). If this has been decided already, I did not find discussion.
INSERT DIAGRAM HERE
(I do not know how we should submit graphics / diagrams for wiki documentation at this time. What process should we use?) Surely the graphics should be located on the egroupware site rather than hyperlinks to other servers!?
Aldo
Before publishing I think the wiki needs a little bit of organization.
I also think that the wiki as it is should not go public, that we better add our writings here in an organized manual what perhaps should be a html bookmark structure. This ahould be english and if somebody adds translatin they should be available as new manuals. Only my opinion is that this what egw gets a better and nicer face. So the text should not follow below each headline, rather a link to the bookmark
(GO HERE TO THE MANUAL LAYOUT)
João
Q: Accordingly to your proposal, how should we adapt "user's manual" (i.e: what belong to and what doesn't belong) ?
Q: Do we accept documentation redondancy (i.e: chapters content equality in both "admin" and "user" doc) ?
bertrand
- João answers: don't know if user manual definition is necessary, it is a quiet clear term (or since we don't have one not ;), isn't it? Each developer should write how the app is meant to function and to be used in order to function so. Then it's up usability people to revise it and release it. On the other side the adm manual should instruct the egw administrator how to set up the programm and the modules correctly that the user can use it in order to get the promised function. Obviously we must distinguish between EGW ADM and EGW APP ADM, which certainly also could be different persons. If there is redundancy or not, I don't know, if necessary for understanding it is, otherwise you force the adm to read first the user manual. So already going into details, where perhaps usability has a role, we should consider (if we want to make a good manual) putting a flow diagram into the adm manual.
Q: Pardon the questions as I am new here...
1) Do you have a development copy of the admin and user manuals so that we can see and update them before we publish to production (web site)? Have I not found it? Do you develop documentation like code:
internal wiki
Dev copy of
documentation
with group
collaboration
|
Approval Process
|
V
external (public web)
Publicly viewed
documentation on
egroupware.org wiki
2) If not, do you object to me making one?
AldoRenwald
02/16/04
I have submitted a proposal for how the documentation process might flow. Please post your comments here (good / bad). If this has been decided already, I did not find discussion.
INSERT DIAGRAM HERE
(I do not know how we should submit graphics / diagrams for wiki documentation at this time. What process should we use?) Surely the graphics should be located on the egroupware site rather than hyperlinks to other servers!?
Aldo