Re: [DOCUMENTATION] Fixing our End User Documentation Problem

[Michael Brohl]

I think it would be great if we could refer to the wiki pages but have the look & feel of the (new) website.

Regards,

Michael Brohl
ecomify GmbH
www.ecomify.de


Am 30.05.17 um 15:16 schrieb Sharan Foga:

I'm not sure how it is done but the Camel people refer to their wiki pages in Confluence but the website does not look like Confluence. Just click on "edit page" at the end of the pages and you'll be directed to Confluence. This way we could have the advantages of a wiki but have also a nicer user experience.

Thanks Pierre!



Thanks
Sharan

On 30/05/17 14:43, Pierre Smits wrote:

At the moment the new website has a menu option called 'Documentation' and a submenu 'User Documentaton' with a link that doesn't actually point anywhere yet. So this is where a key entry point will be. We could also add specific links from the home page or page footer as a quick link.

Great initiative!

How does is this going to fit into our new website initiative?

Best regards,

Pierre Smits

ORRTIZ.COM <http://www.orrtiz.com>
OFBiz based solutions & services

OFBiz Extensions Marketplace
http://oem.ofbizci.net/oci-2/

On Tue, May 30, 2017 at 11:12 AM, Taher Alkhateeb <
slidingfilame...@gmail.com> wrote:

+1

Fantastic initiative.

On Tue, May 30, 2017 at 12:10 PM, Sharan Foga <sharan.f...@gmail.com>
wrote:

Excellent and thanks for the link Michael!

Thanks
Sharan


On 30/05/17 11:07, Michael Brohl wrote:

Hi Sharan, Craig,

this is great and will fit well into the Wiki restructure efforts.

For the FAQ or how-tos, we can check the user questions and start with the most frequently asked questions/answers found on the mailing lists

and

stack overflow [1].

Looking forward to your documentation results,

best regards,

Michael Brohl
ecomify GmbH
www.ecomify.de

[1] https://stackoverflow.com/questions/tagged/ofbiz


Am 30.05.17 um 10:12 schrieb Sharan Foga:

Hi All


problem. Our goal is to improve the OFBiz documentation and provide

Craig Parker and I are planning to take on our End User Documentation

some

useful information for users and non-technical people. We plan to work

on

the following:

*_OFBiz Glossary_*


    when trying to explain what they are)

*_Menu Structured Documentation _*

  * This will follow the existing menu structure and will eventually
    replace / update the current in application screen help that is
    already in OFBiz.

    plugins

*_End User Guide_*


  * It will include a list of basic tasks for each process
  * It will also include links to examples

*_How Tos_*


    set of these will focus on downloading and installing OFBiz)

*_Examples and Tutorials_*


    real life scenario
  * It will build understanding (and familiarity) by having a common
    theme or story

*_Training Matrix_*


    but I think that could be done after the other content has been
    developed.

*_Implementation Strategy and Next Steps_*

prepare all of these. I prefer using a separate space where we won't

* Put together a full glossary of OFBiz terms so that the concepts are clear (things like catalogs, parties, even products can be confusing * The focus of this effort will be to standardise the information and complete missing information initially for core modules and official * This will give users an overview of the applications and processes * This will be a quick reference How-To by area (for example the first * This will provide practical examples of using the applications in a * We also talked about putting together some form of Training Matrix I'd like to temporarily recover and use the End User Docs workspace to

need

to be concerned about the wiki re-organisation. Also at the moment

there is

already some user documentation in the End User Docs workspace so we

can

review that as part of the documentation effort and incorporate it or

re-write it where it necessary.


sensitive help. The main thing we are missing is content - once we

Another idea is that the End User Docs workspace could be a good place to store what will become the replacement for our in application screen

have the

content we look at extracting it into whatever format we need.


the re-organised documentation space in the wiki.


encourage contributions and feedback from our user community.


then please let me know.

Thanks
Sharan

As the documentation sections are completed we will move them over to At this stage we are going to be having any documentation discussions etc on this list but the aim is that this effort will eventually also Also if anyone else is interested in helping contribute to this effort

smime.p7s
Description: S/MIME Cryptographic Signature