ecss-x-hb-...ecss.nl/.../ecss-handbook-template-version6.0(july2015).docx · web viewspace...

15
ECSS-Document-HB-Number ECSS HB Issue Date Space engineering, product assurance Title of handbook This document is …. END OF ….. is: DISCLAIMER (for drafts) This document is an ECSS Draft Standard. It is subject to change without any notice and may not be referred to as an ECSS document until published as such. ECSS Secretariat ESA-ESTEC Requirements & Standards Division

Upload: dinhkien

Post on 22-Mar-2018

230 views

Category:

Documents


5 download

TRANSCRIPT

Page 1: ECSS-X-HB-...ecss.nl/.../ECSS-Handbook-Template-version6.0(July2015).docx · Web viewSpace engineering, product assurance Title of handbook Foreword This Handbook is one document

ECSS-Document-HB-NumberECSS HB Issue Date

Space engineering, product assuranceTitle of handbook

This document is ….

END OF ….. is:

DISCLAIMER (for drafts)This document is an ECSS Draft Standard. It is subject to change without any notice and may not be referred to as an ECSS document until published as such.

ECSS SecretariatESA-ESTEC

Requirements & Standards DivisionNoordwijk, The Netherlands

Klaus Ehrlich, 03/23/09,
CHANGES TO TEMPLATE 5.4 (18July2008):New numbering stream for DRD1,DRD2 and DRD3. No longer linked to Annex numbering stream. The number <1> has to be reset manually!Klaus 28Oct2008
ela, 23/03/09,
Style: Subtitle
K. Ehrlich, 26/02/10,
Dear WG members,I have created for your ECSS Working Group a so called "Team Website" where we ask you to store all information, such as Minutes of meeting, WG Drafts and supporting material, during the development of your ECSS document.A presentation about the functionalities will be given at the Kick-off meeting by the Secretariat.You should be able to access this Team Website using your ECSS Login.Should you encounter problems, please contact me.Best regardsKlaus EhrlichECSS Executive Secretariat
ela, 23/03/09,
To update this information use the following steps: File->Properties Sheet – Tab “Summary”Enter the following information which which automatically get inserted:Title -> Enter here the ECSS reference of the documentSubject field -> The title of the Standard+++++++++++++++++++++++++On the Tab “Custom”:Update the values for:ECSS Standard Number ECSS Standard Issue DateECSS Working GroupECSS DisciplineThese values have to be updated by placing the cursor on the field and pressing the [F9] keyThis can also be done for the entire document by selecting everything and [F9]DO NOT ENTER HERE!Style: Title ONLY USED HERE
Page 2: ECSS-X-HB-...ecss.nl/.../ECSS-Handbook-Template-version6.0(July2015).docx · Web viewSpace engineering, product assurance Title of handbook Foreword This Handbook is one document

ECSS-Document-HB-NumberECSS HB Issue Date

ForewordThis Handbook is one document of the series of ECSS Documents intended to be used as supporting material for ECSS Standards in space projects and applications. ECSS is a cooperative effort of the European Space Agency, national space agencies and European industry associations for the purpose of developing and maintaining common standards.The material in this Handbook is defined in terms of description and recommendation how to organize and perform the work of ….

This handbook has been prepared by the name of group Working Group, reviewed by the ECSS Executive Secretariat and approved by the ECSS Technical Authority.

DisclaimerECSS does not provide any warranty whatsoever, whether expressed, implied, or statutory, including, but not limited to, any warranty of merchantability or fitness for a particular purpose or any warranty that the contents of the item are error-free. In no respect shall ECSS incur any liability for any damages, including, but not limited to, direct, indirect, special, or consequential damages arising out of, resulting from, or in any way connected to the use of this document, whether or not based upon warranty, business agreement, tort, or otherwise; whether or not injury was sustained by persons or property or otherwise; and whether or not loss was sustained from, or arose out of, the results of, the item, or any services that may be provided by ECSS.

Published by: ESA Requirements and Standards DivisionESTEC, P.O. Box 299,2200 AG NoordwijkThe Netherlands

Copyright: 2015© by the European Space Agency for the members of ECSS

2

Enrique Gonzalez-Conde, 23/03/09,
Style: paragraphParagraph is the “normal” style
K. Ehrlich, 26/02/10,
Enrique Gonzalez-Conde, 23/03/09,
Style: paragraphParagraph is the “normal” styleThe name of the working group is automatically inserted.
M. Coutois, 23/03/09,
To be completed.
Page 3: ECSS-X-HB-...ecss.nl/.../ECSS-Handbook-Template-version6.0(July2015).docx · Web viewSpace engineering, product assurance Title of handbook Foreword This Handbook is one document

ECSS-Document-HB-NumberECSS HB Issue Date

Table of contents

Change log.................................................................................................................4

Introduction................................................................................................................5

1 Scope.......................................................................................................................6

2 References...............................................................................................................7

3 Terms, definitions and abbreviated terms............................................................83.1 Terms from other documents......................................................................................8

3.2 Terms specific to the present document.....................................................................8

3.3 Abbreviated terms.......................................................................................................8

4 Principles.................................................................................................................94.1 Clause four-one...........................................................................................................9

4.1.1 Clause four-one-one.....................................................................................9

4.1.2 Clause-four-one-two......................................................................................9

4.1.3 Equations....................................................................................................10

4.1.4 Tables and captions....................................................................................10

Annex A Here the title of the annex........................................................................11A.1 Clause A-one............................................................................................................11

A.1.1 Clause A-one-one.......................................................................................11

Figures

Figure 5-1: Title of the figure.....................................................................................................3

Figure A-1 : This is an autonamically numbered figure for Annexes which is created by creating a style Caption:Annex Figure...................................................................3

Figure A-2 : Another figure........................................................................................................3

Tables

Table 5-1: Title of the table.......................................................................................................3

Table A-1 : First Table in Annex A ...........................................................................................3

3

Enrique Gonzalez-Conde, 23/03/09,
Style: Contents (so that it does not get included in the TOC)For high level headings without numbering
Enrique Gonzalez-Conde, 23/03/09,
Style: PublishedONLY USED HERE
Page 4: ECSS-X-HB-...ecss.nl/.../ECSS-Handbook-Template-version6.0(July2015).docx · Web viewSpace engineering, product assurance Title of handbook Foreword This Handbook is one document

ECSS-Document-HB-NumberECSS HB Issue Date

Change log

ECSS-Document-HB-NumberECSS HB Issue Date

Word file to start with

4

Page 5: ECSS-X-HB-...ecss.nl/.../ECSS-Handbook-Template-version6.0(July2015).docx · Web viewSpace engineering, product assurance Title of handbook Foreword This Handbook is one document

ECSS-Document-HB-NumberECSS HB Issue Date

Introduction

Introduction

5

Enrique Gonzalez-Conde, 23/03/09,
Style: paragraphParagraph is the “normal” style
Enrique Gonzalez-Conde, 23/03/09,
Heading0For high level headings without numbering
Page 6: ECSS-X-HB-...ecss.nl/.../ECSS-Handbook-Template-version6.0(July2015).docx · Web viewSpace engineering, product assurance Title of handbook Foreword This Handbook is one document

ECSS-Document-HB-NumberECSS HB Issue Date

1Scope

Scope

6

Enrique Gonzalez-Conde, 23/03/09,
Style: paragraphParagraph is the “normal” style
Enrique Gonzalez-Conde, 23/03/09,
Headng1
Page 7: ECSS-X-HB-...ecss.nl/.../ECSS-Handbook-Template-version6.0(July2015).docx · Web viewSpace engineering, product assurance Title of handbook Foreword This Handbook is one document

ECSS-Document-HB-NumberECSS HB Issue Date

2References

Reference 1 Title 1Reference 2 Title 2

7

Enrique Gonzalez-Conde, 23/03/09,
TableCellLeftTo be used in tables, with the text aligned to the left of the cell
Enrique Gonzalez-Conde, 23/03/09,
TableCellLeftTo be used in tables, with the text aligned to the left of the cell
Enrique Gonzalez-Conde, 23/03/09,
Heading1
Page 8: ECSS-X-HB-...ecss.nl/.../ECSS-Handbook-Template-version6.0(July2015).docx · Web viewSpace engineering, product assurance Title of handbook Foreword This Handbook is one document

ECSS-Document-HB-NumberECSS HB Issue Date

3Terms, definitions and abbreviated terms

3.1 Terms from other documentsa. For the purpose of this document, the terms and definitions from ECSS-S-ST-00-01

apply, in particular for the following terms:1. xxx

3.2 Terms specific to the present document3.2.1 first definitiondefinition text 1

3.2.2 second definitiondefinition text 2

3.3 Abbreviated termsFor the purpose of this document, the abbreviated terms from ECSS-S-ST-00-01 and the following apply:

Abbreviation MeaningABB Expanded meaning

8

Enrique Gonzalez-Conde, 23/03/09,
TableCellLEFT
Enrique Gonzalez-Conde, 23/03/09,
Style: tableCellLEFT, make it bold.
Enrique Gonzalez-Conde, 23/03/09,
TableHeadingLeft
Enrique Gonzalez-Conde, 23/03/09,
Heading2
Enrique Gonzalez-Conde, 23/03/09,
Style: paragraphParagraph is the “normal” style
Enrique Gonzalez-Conde, 23-03-09,
Definition1
Enrique Gonzalez-Conde, 23/03/09,
Heading2
ela, 23/03/09,
This is optional text, include if there is a list of terms from this or other standards (that are named here) which apply. Else delete
Enrique Gonzalez-Conde, 23/03/09,
Heading2
Enrique Gonzalez-Conde, 23/03/09,
Heading1
Page 9: ECSS-X-HB-...ecss.nl/.../ECSS-Handbook-Template-version6.0(July2015).docx · Web viewSpace engineering, product assurance Title of handbook Foreword This Handbook is one document

ECSS-Document-HB-NumberECSS HB Issue Date

4Principles

4.1 Clause four-one

4.1.1 Clause four-one-oneThe style “paragraph” is used for descriptive text.

4.1.2 Clause-four-one-twoFollowing are the styles for lists in descriptive text of the document a. List:level1

1. List:level22. List:level23. List:level3

(a) Xxx(b) Xxx

NOTE Text of the Note.b. Style list:level1

Indentpara11. List:Level2

Indentpara2(a) List:level3

Indenpara3(b) List:level3

NOTE 1 Text of numbered Note 1.NOTE 2 Text of numbered Note 2.

Text of bullet Note Text of bullet Note

9

Ela , 23/03/09,
Style: indentpara3Use for indent paras for text and requirements
Ela , 23/03/09,
Style: indentpara2Use for indent paras for text and requirements
Ela , 23/03/09,
Style: indentpara1Use for indent paras for text and requirements
Klaus Ehrlich, 23/03/09,
Style: list:level3
Klaus Ehrlich, 23/03/09,
Style: list:level2
Klaus Ehrlich, 23/03/09,
Style: list:level1 (automatically restarts numbering)
Klaus Ehrlich, 23/03/09,
Style: paragraph
Enrique Gonzalez-Conde, 23/03/09,
Style: Heading3
Enrique Gonzalez-Conde, 23/03/09,
Style: Heading2
Enrique Gonzalez-Conde, 23/03/09,
Style: Heading1
Page 10: ECSS-X-HB-...ecss.nl/.../ECSS-Handbook-Template-version6.0(July2015).docx · Web viewSpace engineering, product assurance Title of handbook Foreword This Handbook is one document

ECSS-Document-HB-NumberECSS HB Issue Date

Figure 4-1: Title of the figure

4.1.3 EquationsIf an equation is numbered as shown, then create a 2-column table row as shown below and use TableCellCenter styles to centre them . All other equations can be created as part of the text and centre as appropriate.

A=∑n=1

t

A ( xn− xn) [4-1]

4.1.4 Tables and captionsTable titles cannot be created within the table rows/cells, they have to be created above the table thus: Create the caption outside the table using InsertReference Caption Apply the style Caption Table.

- This is a 2nd level bullet- xxx

o This is a 3rd level bulleto Another 3rd level bullet

A 4th level bullet …

xxx

Table 4-1: Title of the tableTable Heading

1Heading 2 Heading 3 Heading 4

Info in the table a. X b.

a. Footnote in tables are numbered with letter, starting with “a.” b. The Tab in the Table Footnote is created by pressing “ CTRL + TAB”NOTE 1 Notes to Tables are using the style “ Table:Note

10

ela, 23/03/09,
Style: Table:NoteEnter the text NOTE (and number) [ tab]
ela, 23/03/09,
Style: Table:Footnote
Enrique Gonzalez-Conde, 23/03/09,
Style: TableCellLEFT or TableCellCENTER
Enrique Gonzalez-Conde, 23/03/09,
Style: TableHeaderLEFT, or TableHeaderCENTER
Enrique Gonzalez-Conde, 23/03/09,
Style: CaptionTable.HOW TO APPLY:Create the caption for Tables. The style Caption is automatically applied.Change the style to CaptionTable
ela, 23/03/09,
Style: Bul4
ela, 23/03/09,
Style: Bul3
Enrique Gonzalez-Conde, 23/03/09,
Style: TableCellCenter
Enrique Gonzalez-Conde, 23/03/09,
If an equation is numbered as shown, then create a 2-column table row and use TableCellCenter styles to centre them
Enrique Gonzalez-Conde, 23/03/09,
Style CaptionTo be used with captions for Figures.It is automatically applied when creating the Caption.
Enrique Gonzalez-Conde, 03/23/09,
Style: graphicTo be used with ALL figures
Page 11: ECSS-X-HB-...ecss.nl/.../ECSS-Handbook-Template-version6.0(July2015).docx · Web viewSpace engineering, product assurance Title of handbook Foreword This Handbook is one document

ECSS-Document-HB-NumberECSS HB Issue Date

Annex AHere the title of the annex

A.1 Clause A-one

A.1.1 Clause A-one-one

A.1.1.1 Clause A-one-one-one

A.1.1.1.1 Clause A-one-one-one-oneFor Annexes the style to be used is paragraph.For formatting it is permitted to use the various levels of the list:level styles (list:level1 to list:level3) and the Bul-styles (Bul:1 to Bul:4).a. Text

1. This is an example of a numbered list.(a) This is a sublist in a list (b) A second sub-item

2. A second listb. xxxx

A.1.1.1.2 Clause A-one-one-one-one

……

11

Enrique Gonzalez-Conde, 23/03/09,
Style: Annex5
ela, 23/03/09,
Style: list:level2
Enrique Gonzalez-Conde, 23/03/09,
Style: list:level1This style may be used to format descriptive text.BUT this number it has to be restarted MANUALLY here!
Enrique Gonzalez-Conde, 23/03/09,
Style: Annex5
Enrique Gonzalez-Conde, 23/03/09,
Style: Annex4
Enrique Gonzalez-Conde, 23/03/09,
Style Annex3
Enrique Gonzalez-Conde, 23/03/09,
Style: Annex2
Enrique Gonzalez-Conde, 23/03/09,
Style: Annex1
Page 12: ECSS-X-HB-...ecss.nl/.../ECSS-Handbook-Template-version6.0(July2015).docx · Web viewSpace engineering, product assurance Title of handbook Foreword This Handbook is one document

ECSS-Document-HB-NumberECSS HB Issue Date

Figure A-1: This is an autonamically numbered figure for Annexes which is created by creating a style Caption:Annex Figure

Figure A-2: Another figure

Table A-1: First Table in Annex A Table Heading 1

Heading 2 Heading 3 Heading 4

Info in the table X

a. Footnote in tables are numbered with letter, starting with “a.”b. The Tab in the Table Footnote is created by pressing “ CTRL + TAB”c. xxxNOTE 1 Notes to Tables are using the style “ Table:NOTE

12

Enrique Gonzalez-Conde, 23/03/09,
Style: TableCellLEFT or TableCellCENTER
Enrique Gonzalez-Conde, 23/03/09,
Style: TableHeaderLEFT, or TableHeaderCENTER
ela, 23/03/09,
Style: Caption:Annex TableThis is automatically numbered (for annex number and figure number, which restarts with each annex.
ela, 23/03/09,
Style: Caption:Annex FigureThis is automatically numbered (for annex number and figure number, which restarts with each annex.