First Entries Re: [bika-users] User manual

[lemoene]

Hi All

I have been snapping screenshots - Jira Capture is King! - in testing sessions, expanded with content from training requirements and user questions, and slapped them into a gap toothed new manual at https://www.bikalims.org/manual that is starting to shape.

Creative commons'd with the hope it the texts could make it into the much desired dynamic manual updated form the code.

Spread liberally!
Bests
l

Where I can download editable version of Bika 3 User manual (in ODT/DOC/RTF or zipped HTML pages)? I need it for translation. In address https://demo.bikalabs.com/knowledge-centre/manual/bika-3-user-manual is user manual marked as outdated, and not downloadable (as 1 file).

There's a download url at the bottom of the Contents page, https://demo.bikalabs.com/knowledge-centre/manual/bika-3-user-manual, All content on one page (useful for printing, presentation mode etc.) from where IO suppose one can print to file.

We should start a community project to update the manual, in a format that can be translated via a tool like Transifex, and automatically updated from the code with say Sphinx. Things remain too fluid to make videos, especially now, the devs a re bound to reveal the next Bika evolution soon.

Code sponsors and clients never want to spend on documentation after they have been through Analysis and Design, Acceptance testing - as they know their own customisations inside out, and picked the rest up on the way. Does not help for new community users though ...

If you have budget, please proceed amongst the above guidelines, I am trying to get  some sponsor ship from a prospect next week too. We should get to a way of doing it, everybody can contribute too. Once we have  a spec of some sorts, maybe put the tech bits up for a Google Summer of Code 2018?

Looking forward to hear from you

Bests
l

[Alex Kukukhoto]

Hi Lemoene,

I think got a word version (the one created by you originally) of bika lies 3 manual and worked/edited on and off in the past few months.

I can email you that document if you or Senaite may find useful.

and I am interested in contributing working on the manual (with my spare time) if you can let me know how.

best regards,

Alex

------------------------------------------------------------------------------
Check out the vibrant tech community on one of the world's most
engaging tech sites, Slashdot.org! http://sdm.link/slashdot
_______________________________________________
Bika-Users mailing list
Bika-...@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/bika-users

[lemoene]

Much appreciated Alex

Hi Lemoene,I think got a word version (the one created by you originally) of bika lies 3 manual and worked/edited on and off in the past few months. I can email you that document if you or Senaite may find useful. and I am interested in contributing working on the manual (with my spare time) if you can let me know how.

Ultimately we want the manual being updated from the code and stay up to date that way. The devs are all very busy, even more than before, and imho there is no damage in collecting texts and screenshots while we train and respond to questions already, the code can eventually pick these texts up to start with.

I am very comfortable in Plone and we can use its Document workflow of editors and reviewers, comment etc. Jira Capture, if you are not using it already, makes in-browser screen grabbing and annotations fun it is so easy,

I propose I give all volunteer editors authorisation to create and edit pages online, and publication rights to trusted reviewers. All Creative Commons with a credits page. I'll see if whether I can lure a tech with that to make us a Plone 5 site and try building out Plone Help Centre, which was what we used on Plone 3 and does auto numbering, table of Contents, chapters etc;-) The one I started now is still Plone 4, same as Bika Senaite's which is a potential reason to keep it there and provide Plone exports for users... mmm, never thought of that before.

In very first Bika I we actually distributed a Lab Client user manual on CD - the lab's clients were largely web illiterate farmers;-)

For now, please mail me your doc with the parts you modified, marked up and I'll go for a merge while we also sort out the workflow and roles, should be pretty standard Plone. And get a standards page together, I suppose like this, . Jira capture has a few colours but nothing stands out like the ugly orange...

Hugely appreciated
l

Will open another thread shortly about improving the texts in the UI

[lemoene]

On 08/04/2018 13:57, lemoene wrote:

Much appreciated Alex

Hi Lemoene,I think got a word version (the one created by you originally) of bika lies 3 manual and worked/edited on and off in the past few months. I can email you that document if you or Senaite may find useful. and I am interested in contributing working on the manual (with my spare time) if you can let me know how.

Ultimately we want the manual being updated from the code and stay up to date that way. The devs are all very busy, even more than before, and imho there is no damage in collecting texts and screenshots while we train and respond to questions already, the code can eventually pick these texts up to start with.

I am very comfortable in Plone and we can use its Document workflow of editors and reviewers, comment etc. Jira Capture, if you are not using it already, makes in-browser screen grabbing and annotations fun it is so easy,

I propose I give all volunteer editors authorisation to create and edit pages online, and publication rights to trusted reviewers. All Creative Commons with a credits page. I'll see if whether I can lure a tech with that to make us a Plone 5 site and try building out Plone Help Centre, which was what we used on Plone 3 and does auto numbering, table of Contents, chapters etc;-) The one I started now is still Plone 4, same as Bika Senaite's which is a potential reason to keep it there and provide Plone exports for users... mmm, never thought of that before.

In very first Bika I we actually distributed a Lab Client user manual on CD - the lab's clients were largely web illiterate farmers;-)

For now, please mail me your doc with the parts you modified, marked up and I'll go for a merge while we also sort out the workflow and roles, should be pretty standard Plone. And get a standards page together, I suppose like this,

Manual Convention