Return-Path: X-Original-To: apmail-openoffice-doc-archive@minotaur.apache.org Delivered-To: apmail-openoffice-doc-archive@minotaur.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id 8B460E84A for ; Mon, 21 Jan 2013 01:42:02 +0000 (UTC) Received: (qmail 93264 invoked by uid 500); 21 Jan 2013 01:42:02 -0000 Delivered-To: apmail-openoffice-doc-archive@openoffice.apache.org Received: (qmail 93217 invoked by uid 500); 21 Jan 2013 01:42:02 -0000 Mailing-List: contact doc-help@openoffice.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: doc@openoffice.apache.org Delivered-To: mailing list doc@openoffice.apache.org Received: (qmail 93208 invoked by uid 99); 21 Jan 2013 01:42:02 -0000 Received: from minotaur.apache.org (HELO minotaur.apache.org) (140.211.11.9) by apache.org (qpsmtpd/0.29) with ESMTP; Mon, 21 Jan 2013 01:42:02 +0000 Received: from localhost (HELO mail-ob0-f182.google.com) (127.0.0.1) (smtp-auth username robweir, mechanism plain) by minotaur.apache.org (qpsmtpd/0.29) with ESMTP; Mon, 21 Jan 2013 01:42:02 +0000 Received: by mail-ob0-f182.google.com with SMTP id uo13so656743obb.27 for ; Sun, 20 Jan 2013 17:42:01 -0800 (PST) MIME-Version: 1.0 X-Received: by 10.182.187.66 with SMTP id fq2mr12793183obc.86.1358732521251; Sun, 20 Jan 2013 17:42:01 -0800 (PST) Received: by 10.182.225.66 with HTTP; Sun, 20 Jan 2013 17:42:01 -0800 (PST) In-Reply-To: References: Date: Sun, 20 Jan 2013 20:42:01 -0500 Message-ID: Subject: Re: Starting to build the user guide [Was Re: Possible workflow] From: Rob Weir To: doc@openoffice.apache.org Content-Type: text/plain; charset=UTF-8 On Sun, Jan 20, 2013 at 10:08 AM, RGB ES wrote: > 2013/1/18 RGB ES > >> I started to create the User Guide pages on the wiki >> >> http://wiki.openoffice.org/wiki/Documentation/UserGuide >> >> > > I need some help here. There are now several pages covering the beginning > of the guide > > http://wiki.openoffice.org/wiki/Documentation/UserGuide/UI > http://wiki.openoffice.org/wiki/Documentation/UserGuide/Formatting > http://wiki.openoffice.org/wiki/Documentation/UserGuide/SearchReplace > http://wiki.openoffice.org/wiki/Documentation/UserGuide/AutoCorrect > http://wiki.openoffice.org/wiki/Documentation/UserGuide/Extensions > http://wiki.openoffice.org/wiki/Documentation/UserGuide/Options > and the sub page > http://wiki.openoffice.org/wiki/Documentation/UserGuide/Options/AOO > > All these pages needs proofreading (as you can see, English is not my > native language) and someone that fill their holes. > > The page about supported file formats is completely empty and needs an > author > http://wiki.openoffice.org/wiki/Documentation/UserGuide/FileFormats > > I think a general spellcheck guide is also needed, but not sure where to > put it on the "tree". Maybe below Formatting and before SearchReplace? > > Also, install guides are needed, maybe at the beginning of the guide? I > wrote a Linux install guide on the forums that can be "wikified": > > http://forum.openoffice.org/en/forum/viewtopic.php?f=74&t=50119 > > In the near future I can start with the Writer and Math guides, but someone > needs to take care of other components. > > Thoughts? Volunteers? ;) > Do we want to have a "call for volunteers" soon? Or do you want to make more progress first? -Rob > Regards > Ricardo > > > >> Even if there is some content scattered on those pages (the UI page and >> Java section under Options menu... someone needs to check my grammar) they >> are mainly empty right now, but on the following days I'll try to translate >> what it is already done on the ES wiki >> >> http://wiki.openoffice.org/wiki/ES/Manuales/GuiaAOO >> >> Regards >> Ricardo >> >> >> >> 2013/1/15 RGB ES >> >>> 2013/1/13 Regina Henschel >>> >>>> Hi Ricardo, >>>> >>>> RGB ES schrieb: >>>> >>>> >>>> >>>> >>>> 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. >>>> 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 >>> >>> >>> >>> 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 >>>> >>>> >>> >>