Документ взят из кэша поисковой машины. Адрес оригинального документа : http://www.eso.org/projects/dfs/team/Users-Manual.doc Дата изменения: Tue Apr 19 18:32:07 2005 Дата индексирования: Sun Apr 13 22:50:54 2008 Кодировка: Поисковые слова: enceladus

[pic]

ESO - EUROPEAN SOUTHERN OBSERVATORY
|

EUROPEAN SOUTHERN OBSERVATORY

Organisation EuropИenne pour des Recherches Astronomiques dans l'HИmisphХre
Austral

EuropДische Organisation fЭr astronomische Forschung in der sЭdlichen
HemisphДre | |










PROJECT NAME


[software/application name]
User's Manual
VLT-MAN-ESO-19xxx-xxxx


Issue 1
Date
9 pages








Prepared: Author's Name


Name Date Signature

Approved: Approver's Name


Name Date Signature

Released: Releaser's Name


Name Date Signature



CHANGE RECORD


|Issue |Date |Affected Paragraphs(s) |Reason/Initiation/Remarks |
| | | | |
| | | | |
| | | | |
| | | | |



TABLE OF CONTENTS

1. Introduction 5
1.1 Intended readership 5
1.2 Applicability statement 5
1.3 Purpose 5
1.4 How to use this document 5
1.5 Related documents 5
1.6 Conventions 5
1.7 Problem reporting instructions 5
2. [Overview section] 5
3. [Installation section] 5
4. [Instruction section] 5
5. [Reference section] 6
Annex A - Error messages and recovery procedures 7
Annex B - Glossary 8
Annex C - Index 9



LIST OF TABLES



LIST OF FIGURES






Introduction


1 Intended readership

Describe who should read the UM.



2 Applicability statement

State which software release the UM applies to.



3 Purpose

Describe the purpose of the document. Describe the purpose of the software.



4 How to use this document

Say how the document is intended to be read.



5 Related documents

Describe the place of the SUM in the project documentation.



6 Conventions

Describe any stylistic and command syntax conventions used.



7 Problem reporting instructions

Summarise the SPR system for reporting problems.



[Overview section]

Describe the process to be supported by the software, and what the software
does to support the process, and what the user and/or operator needs to
supply to the software.



[Installation section]

Describe the procedures needed to the software on the target machine.



[Instruction section]

From the trainee's viewpoint, for each task, provide:
(a) Functional description
What the task will achieve.
(b) Cautions and warnings
Do's and don'ts.
(c) Procedures
Include:
Set-up and initialisation
Input operations
What results to expect
(d) Probable errors and possible causes
What to do when things go wrong.



[Reference section]

From the expert's viewpoint, for each basic operation, provide:
(a) Functional description
What the operation does.
(b) Cautions and warnings
Do's and don'ts.
(c) Formal description
Required parameters
Optional parameters
Default options
Parameter order and syntax
(d) Examples
Give worked examples of the operation.
(e) Possible error messages and causes
List the possible errors and likely causes.
(f) Cross references to other operations
Refer to any complementary, predecessor or successor
operations.



Annex A - Error messages and recovery procedures

List of error messages and recovery procedures



Annex B - Glossary

List all terms with specialised meanings




Annex C - Index

(for manuals of 40 pages or more) List all important terms and their
locations.