[Koha-bugs] [Bug 32391] Reorganise the manual contents

[bugzilla-daemon at bugs.koha-community.org]

https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=32391

David Nind <david at davidnind.com> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
             Status|NEW                         |ASSIGNED

--- Comment #1 from David Nind <david at davidnind.com> ---
Here is a rough outline of what I am thinking about.

Tasks:
- Fine tune the revised contents/structure
- Make available in a shared document for comments/interactive feedback
- Reorganise the index page for feedback (make available as a static site)

Potentially each of the sections could be separate guides, rather than one big
manual, with the contents page organising and linking these together.

Initial focus would be on reorganising the contents, and then later
reorganising content in individual sections/chapters/guides where required -
including adding new sections.

Revised contents outline, with notes
====================================

Using this manual/documentation [about the documentation and how it is
organised]

- Conventions
- Change log [quick notes on what has changed in the documentation, for example
a new guide on a new feature added]

What's new in Koha [more user-friendly 'release' notes]

Koha overview [brief introduction to Koha - key features, modules and tools;
the community]

Getting help

Part X - Getting started [brief outline of process to consider when
implementing, with links to more detailed information/guides/tutorials]

- Implementation [including links to the checklists]
- Data migration
- Installation
- System setup and configuration
- System administration [including managing upgrades]

Part X - Using Koha [sections/chapters/guides on each of the modules, tools and
other features - not sure of the best way to group or organise this yet]

- Finding your way around [getting familiar with the OPAC and staff interface]

- Searching [may be an advanced search guide as well?]

- Patron guide to using the OPAC

- The core modules:
  . Circulation
  . Patrons
  . Cataloging
  . Authorities [combine with cataloguing?]
  . Serials
  . Acquisitions
  . Reports
    ....

- Other modules, features, and tools [not sure how to group yet]
  . Course reserves
  . ERM
  . Interlibrary loans
  . Lists
  . News
  . Notices and slips
  . Patrons
  . Point of sale
  ....

- Enhanced content, integration, and web services [separate sections or part of
above topics where appropriate]

- Customising the OPAC and staff interface
  . Look and feel [theming]
  . JavaScript and CSS

Part X - Implementation guide

Part X - Data migration guide [getting your data into Koha]

Part X - Installation guide

Part X - System setup and configuration

- Using languages other than English

Part X - System administration

- Backups
- Security
- Scheduled jobs [cron jobs]
- Search engines
- Upgrades

Part X - System preferences [Reference]

Part X - Cron jobs [Reference]

Part X - Package commands [Reference]

Index
Glossary
License information

-- 
You are receiving this mail because:
You are watching all bug changes.