ALEPH500 Documentation
E N D
Presentation Transcript
Documentation • 14.2 Seminar • March 2001 Documentation
Agenda • In this session we will show how changes between different versions are reflected in the documentation Documentation
In the beginning… • …there were two types of ALEPH users Documentation
Those who read the documentation… Documentation
…and those who didn’t Documentation
Ex Libris TechnicalWriters’ Motto: • Read the • Documentation! Documentation
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
ALEPH Documentation Readers’ Goals • Learn the ALEPH system • Work with ALEPH • Learn an ALEPH procedure • Keep up-to-date with ALEPH • changes Documentation
ALEPH Documentation Team Goal • To write documentation that is: • Accurate • Comprehensive • User-friendly • Up-to-date • Easily accessible Documentation
ALEPH Documentation • Release Notes • Web Guide • Online Help • Batch Services Help • Word Documents Documentation
1RELEASE NOTES Documentation
Release Notes • If you want to find out what’s new in • a version, go straight to Release • Notes: Documentation
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. Documentation
Staff Menu – Release Notes Documentation
Release Notes Documentation
Release Notes Documentation
Release Notes • Based on rep-vers and • rep-changes • Constantly being updated • Includes current and all • previous versions Documentation
Release Notes • Changes documented in release notes are incorporated into ”regular” documentation: • Web Guide • Online Help • Batch Services Help • Lists Documentation
Release Notes • Changes documented in release notes are incorporated when “upgrading” documentation: • Lists • Implementation Notes Documentation
2WEB GUIDE Documentation
Staff Menu – Web Guide Documentation
Web Guide Main Menu Documentation
Web Guide • The Web Guide is the primary • source of information for ALEPH • librarians Documentation
3ONLINE HELP Documentation
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. Documentation
Online Help • To 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
Online Help –Sample Page Documentation
4BATCH SERVICES HELP Documentation
Staff Menu – Batch Services Documentation
Batch Services Help • Every batch service contains a help section which is updated from version to version in the event of changes. Documentation
Batch Services Help Documentation
5WORD DOCUMENTS Documentation
Staff Menu – Documentation Documentation
WORD Documents – Documentation Menu Documentation
WORD Documents • Located on the ALEPH Staff • Menu / Documentation Menu and • saved in PDF: • Guides • Lists • How-tos Documentation
Guides • A new guide, Customizing ALEPH Reports with Infomaker, reflects the changes in printing. Documentation
Lists • All the lists are updated in 14.2. • The Implementation Notes reflect all the changes in tables. Documentation
Lists Documentation
How-tos • 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. Documentation
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