How to Request a Change to the Global User Guide

[lbwright22]

If you:

1. spot an error,
2. would like a section re-written so that it is more useful for your users and support team
3. have a suggestion for new content to be added then:

Create an Issue here: Issues · openfoodfoundation/ofn-UserGuide · GitHub

I have made the issue templates super easy to fill in. If you would like them tweaked or have suggestions on how they can be improved then please comment below or in the #user-guide channel on Slack.

@Rachel is working on User Facing changes as a result of platform updates automatically creating issues in this Github repo.

The Process is:

1. Issue Created
2. Issue assigned to one of a core team who will maintain the English version of the User Guide.
3. Depending on the complexity of an issue, it will either go straight to being published or there will be revision steps and drafts before the English UG is updated.
4. Once the English UG is updated those who manage other language versions will be able to translate the change and update accordingly.

Changes will progress through this Zenhub board.

• If you manage one of the non-English versions of the UG then you can pick up changes to action from the ‘Completed Update English’ pipe.
• There is an Admin Checkbox on each issue to tick when a particular change has been processed for a language.

The Core User Guide Team
It would be great to have one person from each English speaking instance who has admin rights and has been trained to be part of this.
Current:
UK: @lbwright22
Canada: @JessC
USA:
Australia:

If you are not a native English speaker then you are very welcome to join the core team who update the English guide too- you can write drafts in your preferred language and we can use DeepL or Google Translate to translate and then someone who speaks English can tweak it so it reads smoothly.

I also recognise that if you are from an non-English speaking instance you may already have a lot of work to do, maintaining your language version of the UG and so please do not feel pressured to do both!

Links to past Discourse threads:

User guide harmonizations : what could be our new common skeleton?

Why? We need a common architecture for our user guides to enable easy maintenance, and especially, now that we decided to evolve toward “language user guides” rather than “instance user guides”. In Canada for instance if French speaking people access a user guide radically different from English speaking people that can be problematic, especially for support teams… Evolution we did in France https://ofnuserguidefr.gitbook.io/guide-utilisateur-open-food-network When we worked on the French user…

User Guide as a Living Document - how to keep it current/rich/relevant?

This topic was born on Slack and seems to have outgrown it. We’re talking about the process for editing the user guide and making sure that user guide editors in all languages can benefit from each others work. Copied here are the slack posts that got things going, starting with a thread from Emily Rogers: Here’s a suggestion for how we update the User Guide as a group. This is an interim measure until we can get multiple user accounts for Gitbooks, as we currently have to share editing under a…

How to translate and update/adapt the user guide in a smart and collaborative way?

Hi everyone, Following the conversation: User Guide as a distinct project with its own worklfow There are more and more language communities around OFN as new countries set up OFN instances. With that comes the necessity to translate the user guide, which is today on the openfoodnetwork.org website, and managed and updated by @sstead. That’s a great tool and very usefull (thank you @sstead for the great job!), but we have seen that in France for example, with the first beta testers, we sent t…

Global Gathering 2020 - Day 8 - Collectively Maintaining the User Guide

Links: Google Doc Recording Notion notes: User Guide Updating Global Gathering What is the purpose of this session? The User Guide team is growing, which means we have greater capacity to keep the user guides up to date, and expand. This session is to discuss improving our systems for managing this workload. What outcomes/deliverables do we want? A clear system for managing the work of keeping the various User Guides up to date Who is facilitating? Bato + Emily Who is scribing? Gen S…

Log and Track User Guide Updates in GitHub

There was discussion during the Global Gathering Session on Collectively Maintaining the User Guide about establishing a tool for logging and tracking updates to the User Guide. Updates are required under the following scenarios: An error has been identified, such as inaccurate information or out of date content / screen grabs. When the OFN software is updated, or a new feature has been launched. A section of the User Guide needs to be reviewed / re-written (may not be required ongoing, but c…