User Tools

Site Tools


evergreen-docs:documentation_needs

Evergreen Documentation Needs

High level workflow for documenting new EG features

1. Choose a Task 2. Read Release Notes 3. Update the Docs

- Look at the task list below and add your name next to a task
- Need a wiki account? Just ask.

- Review the release notes entry for the feature (and/or the Launchpad bug)
- It may need a new section in one or more of the official manuals
- It may fit within an existing section
- It may only need updated screenshots
- You may be able to simply copy the release note into the appropriate section

- Make corrections in any
format (perhaps by editing
on GitHub) and share with the email list
- Learn more about ways to contribute your changes

Style Guide

EASY Tasks for New Contributors

Bitesize (simple) documentation bugs on Launchpad:

Pull Requests ready for review (according to Launchpad):

Add Index Terms Throughout the Docs

Add Terms and Definitions to the Glossary

Documentation Re-Organization Clean Up Tasks

Other Documentation Tasks

TIPS

Check Sitka's documentation, especially when documenting older features: Also, consider adding links to their YouTube videos.

Quick Start Guides

We would like to provide an "Evergreen Quick Start" guide for the most common functions of Evergreen. The intended audience is library volunteers, student workers, and staff who are new to libraries. Learn more about the initial idea.

  • Some key features of such a guide would be:
    • Short (hopefully fitting on a single page printout)
    • Simple (no library jargon, no extra explanations)
    • Generic (not specific to any library or consortium)
    • Includes a short video
  • See Sitka's short videos for examples.

Here's a list of the guides we think we need. Feel free to add more!

Check In

Check Out

Adding Holdings

Adding call numbers and items to a bibliographic record.

  • How would you say "bibliographic record" without library jargon?

Undocumented Features/Changes, Taken From Release Notes

Many of these will be easy changes. Some will need no changes at all.

Copy the HTML code below to update the status of an item:

  • Assign yourself: <html><span style="color:blue;font-weight:bold">[your name]</span></html> ([your name])
  • Add a status: <html><span style="color: green;font-weight: bold"> COMPLETE!</span></html> (COMPLETE!)

Acquisitions

Administration

Acquisitions Administration

Notification / Action Triggers

Circulation Administration

Credit Card Processing

Installation / Upgrade / Build / Translation

Other (or not categorized yet)

API

Architecture

Cataloging

Circulation

Billing

Holds

Patrons

Self Check Out

Other (or not categorized yet)

Client

Public catalog

Reports

SIP

Borrow from Shared Docs

Other Requested Documentation

  • Cataloging (needs to be reorganized)
  • Intro to SQL (Based on Dan Scott content) Yamil still needs to make some edits like proper attribution, and test that its addition does not break the full docs
  • Library Settings Editor - (Lynn Floyd, SCLENDS)
  • OpenSRF/Evergreen Installation Guide (two PDFs linked from email below, useful but need updating)
  • Archiving of Circulation Transactions (new section)
  • Addresses on Routing List (missing?)
  • Administration
    • Local Administration
      • Copy Template Editor
      • Field Documentation
      • Group Penalty Thresholds
      • Hold Policies - some very useful info here (especially from a command-line perspective): https://evergreen-ils.org/~bshum/eg12/looking-glass/notes.html
      • Patrons with Negative Balances Lynn Floyd
      • Search Filter Groups
      • Surveys Lynn Floyd
      • Transit List Lynn Floyd
      • Hold Targeting and Hold Targeting script
    • Acquisitions
      • Patron Requests/Acquisition requests - Notes Gist FIXME
    • Server Administration
      • Actor Stat Cat Sip Fields
      • Age Hold Protect Rules
      • Asset Stat Cat Sip Fields
      • Billing Types
      • Circulation Matchpoint Weights - use wiki page
      • Custom Org Unit Trees
      • Global Flags
      • Hold Matchpoint Weights
      • User Setting Types [Stompro]
      • Database Backup and Restore Documentation Notes/In Progress Gist FIXME
      • Loop-Based Hold Targeting & Pickup Location Weight Notes/In Progress Gist FIXME
      • Override Permissions - need docs that explain that any event can have an override permission created.
  • Circulation
  • Patrons
    • Registration - Define any undefined fields and what they're used for

Non-Docs Tasks

  • Incorporate relevant docs links into Web Staff Client screens (i.e. contextual help)
  • Improve docs testing/building via the automated testing server (aka buildbot)
    • Currently, the docs are built (HTML, PDF and ePub) whenever the tests are run (every day around 6am and 6pm EST). If there is any warning or error output, it should signal a failure of the tests.
    • Ideas to improve this include:
  • Improve the PDF version of the built documentation (ask community for usage, ideas, etc.)
  • Setup/use Google analytics to improve docs website design
  • UI improvements
evergreen-docs/documentation_needs.txt · Last modified: 2019/09/13 10:58 by sandbergja

© 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.