ALEPH500 Documentation

Documentation-2-

Documentation14.2 Seminar

March 2001

Documentation-3-

AgendaIn this session we will show how changes between different versions are reflected in the documentation

Documentation-4-

In the beginning……there were two types of ALEPH

users

Documentation-5-

Those who read the documentation…

Documentation-6-

…and those who didn’t

Documentation-7-

Ex Libris TechnicalWriters’ Motto:

Read theDocumentation!

Documentation-8-

ALEPH Documentation Readership

• Librarians (end-users)• System Librarians and / or System Administrators (can change system settings)• Internal (translators, distributors, trainers, sales and marketing, etc.)

Documentation-9-

ALEPH Documentation Readers’ Goals

• Learn the ALEPH system• Work with ALEPH• Learn an ALEPH procedure• Keep up-to-date with ALEPH changes

Documentation-10-

ALEPH Documentation Team Goal

To write documentation that is:• Accurate• Comprehensive• User-friendly• Up-to-date• Easily accessible

Documentation-11-

ALEPH Documentation

1. Release Notes 2. Web Guide3. Online Help4. Batch Services Help5. Word Documents

Documentation-12-

1

RELEASE NOTES

Documentation-13-

Release Notes If you want to find out what’s new in a version, go straight to Release Notes:

Documentation-14-

Release NotesThe release notes contain all the changes that were made in each module and in ALEPH and ORACLE tables. Documentation & Translation and Functionality release notes are organized by module.

Documentation-15-

Staff Menu – Release Notes

Documentation-16-

Release Notes

Documentation-17-

Release Notes

Documentation-18-

Release Notes• Based on rep-vers and rep-changes• Constantly being updated• Includes current and all previous versions

Documentation-19-

Release NotesChanges documented in release notes are incorporated into ”regular” documentation:• Web Guide• Online Help• Batch Services Help• Lists

Documentation-20-

Release NotesChanges documented in release notes are incorporated when “upgrading” documentation:• Lists• Implementation Notes

Documentation-21-

2

WEB GUIDE

Documentation-22-

Staff Menu – Web Guide

Documentation-23-

Web Guide Main Menu

Documentation-24-

Web GuideThe Web Guide is the

primary source of information for

ALEPH librarians

Documentation-25-

3

ONLINE HELP

Documentation-26-

Online HelpWhen reviewing a GUI module in a new version, it is helpful to use the online help to familiarize yourself with any features that you have not previously encountered.

Documentation-27-

Online HelpTo invoke online help:• Click the Help button on any window • Press the F1 key on a menu option• Select Help >Contents from the menu bar

Documentation-28-

Online Help –Sample Page

Documentation-29-

4

BATCH SERVICES HELP

Documentation-30-

Staff Menu – Batch Services

Documentation-31-

Batch Services HelpEvery batch service contains a help section which is updated from version to version in the event of changes.

Documentation-32-

Batch Services Help

Documentation-33-

5

WORD DOCUMENTS

Documentation-34-

Staff Menu – Documentation

Documentation-35-

WORD Documents – Documentation Menu

Documentation-36-

WORD DocumentsLocated on the ALEPH Staff Menu / Documentation Menu andsaved in PDF:• Guides• Lists• How-tos

Documentation-37-

GuidesA new guide, Customizing ALEPH Reports with Infomaker, reflects the changes in printing.

Documentation-38-

ListsAll the lists are updated in 14.2.The Implementation Notes reflect all the changes in tables.

Documentation-39-

Lists

Documentation-40-

How-tosHow-tos contain task-oriented instructions on a large number of different topics. For example, Apache server, catalog record loader, setting up libraries, and many more.

Documentation-41-

Summary• Read Release Notes for details

on all changes between releases.

• Read the Web Guide for in-depth information on all ALEPH modules.

• Read the Implementation Notes for concise listings of table changes.

Documentation-42-