User Tools

Site Tools


evergreen-docs:reorg_2014:audience_focused_layout

Draft of Audience-Focused Layout

General Principles

  • Separate content by audience
  • Provide cross-linking where beneficial
  • Provide global searching (and searching within current book?)

Separate Books Per Audience

Example: See Sitka's Evergreen Training Manual for staff-focused documentation.

BOOK: Developer / Consortium-level admin (server shell access)

QUESTION: Should these be two separate books?

  1. Evergreen Community (where to get help)
  2. Software Installation
  3. Migrating from a legacy system
  4. Migrating Patron Data
  5. System Configuration and Customization
  6. NEW SECTION: System Administration from the shell (how to restart clark, run helper scripts, etc.)
  7. Creating a new skin
  8. TPAC Configuration and Customization
  9. Authentication Proxy
  10. SIP administration
  11. Apache administration (phonelist.pm, rewrite, access handler)
  12. NEW SECTION: Reports for Sys Admins
  13. NEW SECTION: Understanding Permissions (naming conventions, troubleshooting tips, working with permission groups)
  14. NEW SECTION: Optimizing your server
    1. Ask sys admins for more recommendations (e.g. for Apache, memcached, OS)
  15. Developer Resources
  16. Handy SQL queries (taken from random_magic_spells)

BOOK: Local admin (via staff client)

  1. Evergreen Community (where to get help)
  2. Installing the Staff Client
  3. System Administration From the Staff Client: overview
  4. Describing your organization
  5. Describing your people
  6. Library Settings Editor
  7. Acquisitions Administration
  8. Booking Administration
  9. Cataloging Administration
    1. Authorities Administration
    2. Z39.50 Administration
  10. Circulation Administration
    1. Borrowing items: who, what, for how long
    2. Hard due dates
    3. Accepting Credit Card Payments
      1. Stripe
      2. NEW SECTION: Paypal/Authorize.net/etc.
  11. Holds Administration
  12. OPAC Customization
  13. Reports Module

BOOK: Circulation Staff User

  1. Evergreen Community (where to get help)
  2. Using the Staff Client
  3. Circulation
  4. Reports (as relates to their needs)
  5. Using the Public Access Catalog (as relates to their workflows, and for helping patrons)

BOOK: Cataloging Staff User

  1. Evergreen Community (where to get help)
  2. Using the Staff Client
  3. Cataloging
  4. Reports (as relates to their needs)
  5. Using the Public Access Catalog (as relates to their workflows)

BOOK: Acquisitions Staff User

  1. Evergreen Community (where to get help)
  2. Using the Staff Client
  3. Acquisitions
  4. Reports (as relates to their needs)
  5. Using the Public Access Catalog (as relates to their workflows)

BOOK: Serials Staff User

  1. Evergreen Community (where to get help)
  2. Using the Staff Client
  3. Serials
  4. Reports (as relates to their needs)
  5. Using the Public Access Catalog (as relates to their workflows)

Concerns

- Where do details about permissions live? Stuff like this section is gold for troubleshooting permissions issues, but would it live in the cataloger's manual with other documentation of batch import? In the staff sysadmin's manual in a little tiny section of its own?

evergreen-docs/reorg_2014/audience_focused_layout.txt · Last modified: 2016/02/10 12:05 by rjs7

© 2008-2017 GPLS and others. Evergreen is open source software, freely licensed under GNU GPLv2 or later.
The Evergreen Project is a member of Software Freedom Conservancy.