Koha Documentation Team

From Koha Wiki
Jump to navigation Jump to search

The Koha Documentation Team is responsible for maintaining and improving the official documentation for the Koha community.

We welcome new participants and invite anyone interested to attend meetings, volunteer for tasks, and to get in touch with the Documentation Team.

About the Documentation Team

Documentation

To do lists and projects

To do lists

Documentation tasks are now managed in Bugzilla:

Easy, medium and hard tasks

  • Easy tasks to get started with. Relatively easy things to fix, such as formatting, capitalisation, or typos.
    • Academy documentation tasks: in Bugzilla this keyword is used to identify relatively straight forward tasks (and is also a two week event normally held annually in Wellington, NZ to teach high school students about free and open source software)
    • Bug 27382 - [DOCS] [Omnibus] Spelling errors in the manual: links to individual tasks are under 'Depends on'
    • TO ADD
  • Medium tasks to get started with. Things like enhancements where updates to existing content is required, new system preferences, updating screenshots, updating lists and reference information. Some work is required to figure out what needs updating or how it works, but generally it is straight forward to update.
    • System preference changes - new preferences or need updating because of changes
    • Mana knowledge base section - new feature in 19.05: Bug 17047
    • New features for releases - make sure these have been covered for:
      • 20.11
      • 21.05
      • 21.11
      • 22.05
      • 22.11
      • 23.05
    • TO ADD LINKS
  • Hard tasks include new sections, new features, and reviewing sections. Will need to do some planning to work out what is required - including identifying tasks and reference material to develop. Or it might be a complete rewrite or edit!
    • TO ADD

Section reviews

If you have experience in a particular area and intend to review the complete section, create a documentation task in Bugzilla and link to it from here.

  • Installation section/guide (David)
  • .. add the section and your name here ..

Projects

Projects about improving how we manage and deliver our documentation:

  • 29712 - Content development guide
  • 29714 - Git guide for documentation
  • 29716 - Automated screenshots
  • 32391 - Reorganise the manual contents
  • Installation guide
  • Getting started guide
  • Add how-to's at the end of each chapter with common work flows
  • Create a landing page with links to common sections

Content development guide

This is under development - see 29712. Interim resources:

Retrieved from "https://wiki.koha-community.org/w/index.php?title=Koha_Documentation_Team&oldid=31986"