Great advice and resources thank you for sharing. I will take into consideration some of this while implementing the PoC
On Nov 15, 2017 7:53 PM, "Jacques Le Roux" <jacques.le.r...@les7arts.com> wrote: > Thanks Sharan, > > This is more for users I guess? Could the technical documentation be based > on the same? > > So we would need 1st to collect and, I guess more surely, to create the > user stories on which to base our user documentation on, right? > > I know we have some already, thinks like that, right? > https://cwiki.apache.org/confluence/display/OFBIZ/PIM+User+ > Stories,+Use+Cases,+and+Test+Cases > https://cwiki.apache.org/confluence/display/OFBIZ/Sales+ > Order+Management+User+Stories,+Use+Cases,+and+Test+Cases > Todos: > https://cwiki.apache.org/confluence/display/OFBIZ/Order+ > Fulfillment+Process+User+Stories,+Use+Cases+and+Test+Cases > https://cwiki.apache.org/confluence/display/OFBIZ/Customer+ > Relationship+Management+(CRM)+User+Stories,+Use+Cases,+and+Test+Cases > > That's certainly the best long range way, but it will take some ;) > > Jacques > > > Le 15/11/2017 à 16:11, Todd Thorner a écrit : > >> Yes, that is best practice for documentation, thanks for sharing the >> links. >> >> >> >> On 17-11-15 06:29 AM, Sharan Foga wrote: >> >>> Hi All >>> >>> (I'm resending this message as the original message I sent this morning >>> didn't get through to the mailing list. I seem to have an intermittent >>> problem with posting somehow ;-) >>> >>> I recently interviewed Robert Kratky, a Technical Writer from Red Hat >>> about his presentation on documentation at the Open Source Summit in Prague >>> a few weeks ago. He has some good advice for us and anyone looking at >>> writing good documentation. His talk was about how to move from feature >>> based documentation (which is what we have tended to do) to more user story >>> based documentation that is driven more by how our users use the software. >>> >>> You can listen to the interview at the link below: >>> >>> https://wp.me/p8gHED-QF >>> >>> Please take a look at his presentation >>> >>> schd.ws/hosted_files/osseu17/5f/%28OSSEU%2017%29%20Going%20M >>> odular-%20Turning%20Legacy%20Docs%20into%20User-Story-Based% >>> 20Content.pdf >>> >>> and also at the github repo with some guidelines for writing modular >>> documentation, >>> >>> https://github.com/redhat-documentation/modular-docs >>> >>> So as our community continues in its documentation efforts I'd like to >>> highlight that anyone can contribute and help by letting us know how you >>> are using OFBiz and what are your main user stories. >>> >>> Thanks >>> Sharan >>> >>> >>> >>> >> >> >
