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 currently an issue).
It was decided to explore using GitHub to log User Guide updates that are needed, and investigate whether it might be possible to integrate this with the way issue logging and the development pipe is currently managed on GitHub.
What Problem are we Solving?
Currently there is an informal process for User Guide Updating. If a team member wants to request a User Guide Updates or note that the User Guide is currently inaccurate or needs reviewing, they can post in the User Guide channel in Slack. When a change has been made there is a need for translations to take place. This process is also informal, using Slack. The current informal process carries the following risks:
- slack comments can be lost over time
- not all OFN team members are aware of the process
- the updating team may be unaware of changes that are needed
- translations can be missed
Some topics for discussion:
- is GitHub the right platform / tool?
- what would the workflow be?
- who could log a User Guide update?
- what kind of updates would need to be logged
Please share your thoughts below.