ALEPH 500 Documentation 1 Documentation Documentation 14 2

  • Slides: 42
Download presentation
ALEPH 500 Documentation 1 Documentation

ALEPH 500 Documentation 1 Documentation

Documentation 14. 2 Seminar March 2001 2 Documentation

Documentation 14. 2 Seminar March 2001 2 Documentation

Agenda In this session we will show changes between different versions are reflected in

Agenda In this session we will show changes between different versions are reflected in the documentation 3 Documentation

In the beginning… …there were two types of ALEPH users 4 Documentation

In the beginning… …there were two types of ALEPH users 4 Documentation

Those who read the documentation… 5 Documentation

Those who read the documentation… 5 Documentation

…and those who didn’t 6 Documentation

…and those who didn’t 6 Documentation

Ex Libris Technical Writers’ Motto: Read the Documentation! 7 Documentation

Ex Libris Technical Writers’ Motto: Read the Documentation! 7 Documentation

ALEPH Documentation Readership 8 • Librarians (end-users( • System Librarians and / or System

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

ALEPH Documentation Readers’ Goals • • Learn the ALEPH system Work with ALEPH Learn

ALEPH Documentation Readers’ Goals • • Learn the ALEPH system Work with ALEPH Learn an ALEPH procedure Keep up-to-date with ALEPH changes 9 Documentation

ALEPH Documentation Team Goal To write documentation that is: • Accurate • Comprehensive •

ALEPH Documentation Team Goal To write documentation that is: • Accurate • Comprehensive • User-friendly • Up-to-date • Easily accessible 10 Documentation

ALEPH Documentation 1. 2. 3. 4. 5. Release Notes Web Guide Online Help Batch

ALEPH Documentation 1. 2. 3. 4. 5. Release Notes Web Guide Online Help Batch Services Help Word Documents 11 Documentation

1 RELEASE NOTES 12 Documentation

1 RELEASE NOTES 12 Documentation

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

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

Release Notes The release notes contain all the changes that were made in each

Release Notes The 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. 14 Documentation

Staff Menu – Release Notes 15 Documentation

Staff Menu – Release Notes 15 Documentation

Release Notes 16 Documentation

Release Notes 16 Documentation

Release Notes 17 Documentation

Release Notes 17 Documentation

Release Notes • Based on rep-vers and rep-changes • Constantly being updated • Includes

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

Release Notes Changes documented in release notes are incorporated into ”regular” documentation: • Web

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

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

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

2 WEB GUIDE 21 Documentation

2 WEB GUIDE 21 Documentation

Staff Menu – Web Guide 22 Documentation

Staff Menu – Web Guide 22 Documentation

Web Guide Main Menu 23 Documentation

Web Guide Main Menu 23 Documentation

Web Guide The Web Guide is the primary source of information for ALEPH librarians

Web Guide The Web Guide is the primary source of information for ALEPH librarians 24 Documentation

3 ONLINE HELP 25 Documentation

3 ONLINE HELP 25 Documentation

Online Help When reviewing a GUI module in a new version, it is helpful

Online Help When 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. 26 Documentation

Online Help To invoke online help: • Click the Help button on any window

Online Help To invoke online help: • Click the Help button on any window • Press the F 1 key on a menu option • Select Help >Contents from the menu bar 27 Documentation

Online Help – Sample Page 28 Documentation

Online Help – Sample Page 28 Documentation

4 BATCH SERVICES HELP 29 Documentation

4 BATCH SERVICES HELP 29 Documentation

Staff Menu – Batch Services 30 Documentation

Staff Menu – Batch Services 30 Documentation

Batch Services Help Every batch service contains a help section which is updated from

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

Batch Services Help 32 Documentation

Batch Services Help 32 Documentation

5 WORD DOCUMENTS 33 Documentation

5 WORD DOCUMENTS 33 Documentation

Staff Menu – Documentation 34 Documentation

Staff Menu – Documentation 34 Documentation

WORD Documents – Documentation Menu 35 Documentation

WORD Documents – Documentation Menu 35 Documentation

WORD Documents Located on the ALEPH Staff Menu / Documentation Menu and saved in

WORD Documents Located on the ALEPH Staff Menu / Documentation Menu and saved in PDF: • Guides • Lists • How-tos 36 Documentation

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

Guides A new guide, Customizing ALEPH Reports with Infomaker, reflects the changes in printing. 37 Documentation

Lists All the lists are updated in 14. 2. The Implementation Notes reflect all

Lists All the lists are updated in 14. 2. The Implementation Notes reflect all the changes in tables. 38 Documentation

Lists 39 Documentation

Lists 39 Documentation

How-tos contain task-oriented instructions on a large number of different topics. For example, Apache

How-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. 40 Documentation

Summary 41 • Read Release Notes for details on all changes between releases. •

Summary 41 • Read Release Notes for details on all changes between releases. • Read the Web Guide for indepth information on all ALEPH modules. • Read the Implementation Notes for concise listings of table changes. Documentation

42 Documentation

42 Documentation