Download as docx, pdf, or txt
Download as docx, pdf, or txt
You are on page 1of 9

1.

1 Recommendations for creating the CD-ROM and manual


1.1.1 Recommended elements for the CD-ROMs cover layout

Topic logo of publishing house URL of publishing house Main title of product Name of editor (optional) date of change (e.g. Status: October 2009) telephone number for contact (e.g. customer service, in-house hotline) notice of copyrights picture of CD-ROM should comply with the picture of manual

sample in chapter: 4.1 4.2

1.1.2 Recommended elements for the binder of the manual

Topic left inner side: transparent plastic bag for the main chapter overview, logo of publishing house and slogan in case of large binder: plastic clip for holding together (If this is technically not possible anywhere, differences should be discussed with the related supervisor)

sample in chapter: 4.6

1.1.3 Information relating to cover design of the manual

Topic EDP-series or thematic-related titles should be identifiable due to their colours (e.g. green as basic colour for environment-related topics)

sample in chapter: ---

1.1.4 Recommended data relating to book part of the manual

Topic paper colour: white paper weight: 70 gr/m2 number of printed pages: ca. 200-300 Font and size: TimesNewRoman, 10 pt. or

sample in chapter: ---

Page 1 / 9

FORUM MEDIA GROUP

Quality Standards LL

In some cases, different fonts are used (e.g. Arial for headings and TimesNewRoman for texts). This is okay, but there shall not be more than 2 different fonts in the same LL. current status quo of update date on every page
Arial, 9 pt.

June 2009

page 2 / 9

1.1.5 Recommended dimensions of a manuals page (basic volume and update)

Page 3 / 9

FORUM MEDIA GROUP

Quality Standards LL

1.2 Recommendations for creating the index structure


1.2.1 Recommended sequence of first pages (on top of manual)
Topic transparent sheet/envelope including CD-ROM and PIN-codeenvelope transparent folio FORUM guarantee letter (optional; alternative: accompanying basic volume letter) cover sheet (with imprint at the reverse) bookmark update protocol preface sample in chapter: 4.7

1.2.2 Recommended directories and indices (= Chapter 1) of manual


Contents 1 Service and Contents 1.1 Expert service (optional) 1.2 Main content overview 1.3 Editor and authors 1.4 Subject index (has to be updated with every update! The market leader/GM takes decision whether the subscribers will be invoiced for that or not.) 1.5 directory of literature, links 1.6 directory of abbreviations 1.7 directory of symbols and specific signs 1.8 software licence contract 1.9 How to work with the CD-ROM/software (e.g. installation guide, hardware requirement, PIN-code, how-to-use-instructions etc.) (The sequence above is not obligatory and can be different, but all listed elements have to be included somehow.) Every single chapter includes a contents overview/contents list (has always to be updated in case of changes) sample in chapter: ---

June 2009

page 4 / 9

FORUM MEDIA GROUP

Quality Standards LL

1.2.3 Hints for creating Chapter 1


Cover page (inside) Position: Contents: first part of book part title editor, authors FORUM-logo current status of publishing date Imprint

Position: Contents:

on the reverse of the cover page day of very first publishing date all contact data of the publishing house notice basic volume including the XYth update disclaimer of warranty Typesetting and printing by Printed in XY ISBN Preface by the editor after update protocol including month and year of publishing length: 1-2 pages signature and picture of editor reasons for publishing, e.g. legislation change comparison of former situation new situation Hints for using the software short overview of the main chapters short overview of the main topics Content overview

Position: Optional: Possible contents:

General:

as practical as possible PM decides about the level of subchapters The main content overview has to be included in every basic volume. repetitive (recommendation: with every second update) Subject index after content overview keywords in alphabetical order; in average 2 keywords coming from each page of the LL has to be updated every update

Position: General:

June 2009

page 5 / 9

FORUM MEDIA GROUP

Quality Standards LL

1.3 Recommendations for creating the chapter/content structure


1.3.1 Hints for structuring the chapters of the whole product

structure The number of main chapters should not be more than 6-8, so that the orientation is easier for the customer. To offer a special service especially for the FORUM customer, in chapter 1 should also be an explanation of the expert service

--- ---

June 2009

page 6 / 9

FORUM MEDIA GROUP

Quality Standards LL

1.3.2 Hints for structuring the single pages of the manual


Headings 3 hierarchies as maximum (e.g. 2.2.4) The headings shall describe the contents of a chapter very detailed. General headings like General or Introduction shall be avoided! Sub headings should make the text easier to read and help the structure shall not be identical with the chapter headline or a marginal note Marginal notes usually: 1 to 2 per page Marginal notes must be short and detailed lead the reader through the text not repeat the (sub-)headlines be at same time a kind of keyword Every new author has to be trained in the system of formulating marginal notes by PM. Additionally, the system how it works has to be described in the authors handbook. useful hints The length of each chapter or subchapter should not be longer than circa 15 pages, to make the future replacement of the pages easier during the updates. Every new chapter or subchapter should start with a new page on the right side. To make the text easier to read, it is helpful to structure the text with grey boxes, attention signs, paragraph signs etc. At the end of each page there should be the number of pages and the date of last change/replacement. For a comfortable reading, the text should be divided in several paragraphs (there should not be a kind of text desert only).

1.4 Update-related recommendations


1.4.1 Hints how to create manuals cover page and expert service
contents

June 2009

page 7 / 9

FORUM MEDIA GROUP

Quality Standards LL

logo of publishing house title subtitle number of update last date/month/year of change imprint editor/author (optional)

hints! include as many topics as possible, so that every target person feels affected Guarantee that the customers feel they are getting more value than costs. Small topics, which are not explained in detail, shall be listed at the end of the cover sheet (What do you get additionally?) highlight special services (e.g. expert service) expert service (optional) If not included in the basic volume yet, there should be a letter with a detailed description of the procedure (what to do, how to use, whom to send questions, contact data of PM)

1.4.2 Procedure of additional binder for basic volume


Usually, an additional binder has to be avoided, since it is not a benefit for the customer. Additionally, since the manual is not main part of the product, the contents should more concentrate on the CD-ROM. Therefore, as a part of an update strategy, the PM should take care that the basic volume includes one binder only as long as possible (especially by replacement of already existing contents instead of adding additional ones).

June 2009

page 8 / 9

FORUM MEDIA GROUP

Quality Standards LL

June 2009

page 9 / 9

You might also like