2013/1/13 Regina Henschel <[email protected]>
Hi Ricardo,
RGB ES schrieb:
<snip>
I propose to omit the version number level. As can be seen for
ODFAuthors it is unlikely, that all documents are new written for a new
version and sometimes it is not needed at all. LibreOffice 4.0 is in RC1,
but some documents are for 3.4, some for 3.5, and 3.6 is missing totally.
The situation becomes worse, if you think of documentations in other
languages.
I propose this way: Use a hierarchy
/wiki/Documentation/UserGuide/**Tips/Writer
or
/wiki/Documentation/UserGuide/**Writer/Tips
I'm not sure about the best order.
If some content becomes outdated and has to be replaced, then generate a
new page with the same title, but a version addition.
Example: A outdated content in the path
/wiki/Documentation/UserGuide/**General/UI/Customize_Toolbar
would be copied to a path
/wiki/Documentation/UserGuide/**General/UI/Customize_Toolbar_**3_4
and the original page gets a comment line with a link to the old version
and the old version gets a comment line back to the newer version.
This has to be done by the person, who writes the new content.
This has the advantage, that there will be no tree of empty pages, but
the user will always come to the most actual document, when he starts in
/wiki/Documentation and follows the tree.
Good point! I like the idea of moving outdated content to sub-pages.
In the start, when not enough actual content is available, this single
comment line can link to the existing ODFAuthors 3.3 or 3.2 documents or
other suitable wiki pages.
The idea is to create all the pages at once, with just the categories
"Documentation" and "UserGuide" and a template similar to the one we
use on
the ES wiki(2) for "work in process new pages", that we can call "Draft"
(not sure if there is one already: I cannot find it).
Creating a new "UserGuide" section is OK, but same other sections need
to be there from the beginning too. I think of pathes to the developers
guide, to the building guide, to the QA tutorials, to the Calc functions
reference.
Sure. We can update the main documentation page(1) to gather all those
elements on one place.
(1) http://wiki.openoffice.org/wiki/Documentation
In parallel, we can start discussing about writing style, screenshots
(desktop theme...) and related problems on other topics.
There is the page http://wiki.openoffice.org/**
wiki/Documentation/Dashboard/**Wiki_Editing_Policy<http://wiki.openoffice.org/wiki/Documentation/Dashboard/Wiki_Editing_Policy>.
It is already fairly good, and can be used as start. Adaption to AOO is of
cause needed.
Thanks for the link! Looking there I see that the DraftPage template is
already present: {{Documentation/DraftPage}}
After "seeding" some pages with content we start a call for authors and
the
"real writing"(3). Finally, when the author is ready he/she calls for
review/proof reading and when every is OK we delete the "Draft"
template.
What do you think?
I fear, a lot a pages will stay "draft" for ever.
What are your plans about the old Dokumentation hierarchy ?
http://wiki.openoffice.org/**wiki/Documentation/Dashboard/**
Wiki_Editing_Policy#Structure_**of_the_Documentation_Section_**
of_the_Wiki<http://wiki.openoffice.org/wiki/Documentation/Dashboard/Wiki_Editing_Policy#Structure_of_the_Documentation_Section_of_the_Wiki>
No plans, for the moment. I just tried to start the discussion for a self
contained 4.0 user guide written from scratch and easy to maintain.
The structure of the Documentation section on the wiki is indeed quite
complex and it is difficult for a new user to tell apart what's still
valid. Maybe we need to make a completely fresh start here, moving old
content to a "legacy" section... but on the other hand we cannot left the
site empty.
Regards
Ricardo
Kind regards
Regina
