Author’s Toolkit
Recommended Standard
(Blue Book) Job Aid
This job aid and checklistconsolidates all required document-development compliance guidance forBlue Book authors and editors.This aid includes mandatory sections, boilerplate text, and general editorial “Did I/we do that?” assessments to make before sending in a document to the CCSDS document editors.The guidelines provided here have been compiled from the CCSDS Publications Manual (A20.0-Y-3), the April 2013 Technical Editor Boot Camp slides, the Blue Book template, and the Organization and Processes for the Consultative Committee for Space Data Systems (A02.1.Y-3).For additional information, please refer to those documents.
Hyperlinks to boilerplate text and furtherinstructionsare provided throughout this aid.Text inTimes New Romanfontindicates verbatim text extractedfrom the Publications Manual. If needed, users may copy/paste the boilerplate text into their documents[1].
An abbreviated, two-page compliance checklist is provided at the end of this document, as is a graphic that overviews the document-development process for both Blue and Magenta Books.
Before You Start
Pull the latest Blue Book template from the Collaborative Work Environment (CWE).Using the correct template will better ensure compliance with the Publications Manual. Please try to stick to the pre-set styles in the template.
Mandatory Book Contents
Title Page[2]
NOTE:All CCSDS book templates include placeholders for the Title Page items listed below.
CCSDS Logo (included on the template)
Series Name
White Book: ProposedDraftRecommendationfor Space Data System Standards
Red Book: DraftRecommendation for Space Data System Standards
Blue Book: Recommendation for Space Data System Standards
Title (The title must concisely identify the subject of the document.)
Document Type
White Book: ProposedDraftRecommended Standard
Red Book:ProposedRecommended Standard
Blue Book: Recommended Standard
Document Number:The format is CCSDS {number}-{letter}-{issue}
NOTE:The {number} is supplied by the CCSDS Secretariat.
Book Color:WHITE BOOKorRED BOOKorBLUE BOOK
Issue Date:Must be in Mmmm-YYYY format (e.g., July 2013)
Front Matter
NOTE:Hyperlinks to additional instructions and/or boilerplate wording are in blue underline.
Dedication page (used only on instruction from CCSDS Management Council)
Authority page
Statement of Intentpage
Foreword (includes the Agency list)
PrefaceRequired for White and Red Books only.[3]
Document Control (history of the published issues of the document)
Table of Contents:includes a)main section headings and level-two subordinate headings; b) annex main headings; c)index (if applicable); d) figures; and e) tables
Section 1: Introduction
The introduction of the document shall identify and define the document, present conventions used in and definitions specific to the document, and provide a list of referenced documents. The introduction shall contain some or all of the following subsections in the given order.(emphasis added)
NOTE–Not all subsections are required for a given document.
Purpose: Required. […] identif[ies] the purpose of the document
Scope: Required. […] define[s] the area to which [the document] applies
Applicability: Required. […] define[s] the implementations to which the document applies
Rationale: Recommended. […] outline[s] the reasons the book, or a new issue, was published
Document Structure: Recommended. […] outline[s] the structure of the document and briefly identifies the contents of each section and annex
Definitions
Terms (if needed)
Nomenclature:Required.If a Terms subsection is included, Nomenclature goes as a subsection to Terms; otherwise, it can stand as its own subsection under Definitions.
Conventions (if needed)
Patented Technologies:Required if the Blue Book contains specifications that are known to be subject to patent rights.
References(if needed): Required in section 1 if publications are referenced directly in the text of the document.
Section 2:Overview
The overview section shall contain general text on the subject of the document.Sufficient text and/or tables and figures should be used to provide the reader with a clearunderstanding of the scope of the technical content of the book within the overall system.
No requirements or specifications shall be contained in the overview section.
Sections 3–n:Document Main Text (a.k.a. Technical Specifications)
The main text for the document may be spread over many sections and subsections:
Each section of the document shall be devoted to a particular division of the subject.
Specifications shall begin in section 3 and continue through as many subsequent sections as needed.
Each specification shall be explicitly identified by a unique subsection or paragraph number.
Text shall be written in terse style.
Comments and explanatory material shall be clearly identified as non-normative:
the NOTE format [see 4.3.2.2of the Publications Manual]shall be used for brief non-normative comments;
non-normative text requiring one or more paragraphs of text shall be set off in special subsections having one of the following reserved titles:
– Overview;
– Background;
– Rationale;
– Discussion;
descriptive text shall not introduce implicit or hidden requirements, or modify the meaning or obligations of existing requirements;
normative text shall not appear in subsections whose titles are identified as reserved (Overview, Background, Rationale, Discussion)
NOTE–In general, non-normative text is to be avoided in normative sections (sections 3 through n) of CCSDS normative-track documents. CCSDS Informational Reports (Green Books) are the proper repository of non-normative text intended to aid in understanding or acceptance of normative-track documents.
Back Matter (Annexes)
Normative Annexes (as many as needed)
Normative annexes contain technical information which, because of its length, detail, or specificity, is inappropriate for inclusion in the main sections, but which is necessary for implementation of the specifications in the document.
PICS Proforma (PICS = Protocol Implementation Conformance Statement) if necessary.
Informative Annexes (as many as needed)
Security, SANA, and Patent Considerations:Required.At least one of the three must be addressed.
Definitions and Terms
Index (if needed)
Detailed Instructionsand Boilerplate Text
FrontMatter Particulars
Authority Page
The Authority page (included in the template) must include the following:
the Authority text box (see sample below); the box includes theIssue, Date, and Location;
NOTE: On the “Issue” line, the authormay include eitherthe book color (e.g., “Red Book”) or the document type (e.g., “Draft Recommended Standard”) followed by the Issue number.
the Statement of Authorization (boilerplate text below);
the address of the CCSDS Secretariat (boilerplate text below).
Sample Authority Text Box
Issue: / Red Book, Issue nDate: / July 2013
Location: / Washington, DC, USA
Statement of Authorization Boilerplate Text
The Blue Book template includes the verbatim wording shown below as well as the correct spacing/format. The parenthetical statement in the beginning must be included for White and Red Books; it will be removed upon the document’s change to Blue Book status.
(WHEN THIS RECOMMENDED STANDARD IS FINALIZED, IT WILL CONTAIN THE FOLLOWING STATEMENT OF AUTHORITY:)This document has been approved for publication by the Management Council of the Consultative Committee for Space Data Systems (CCSDS) and represents the consensus technical agreement of the participating CCSDS Member Agencies. The procedure for review and authorization of CCSDS documents is detailed in Organization and Processes for the Consultative Committee for Space Data Systems (CCSDS A02.1-Y-3), and the record of Agency participation in the authorization of this document can be obtained from the CCSDS Secretariat at the address below.
This document is published and maintained by:
CCSDS Secretariat
Space Communications and Navigation Office, 7L70
Space Operations Mission Directorate
NASA Headquarters
Washington, DC 20546-0001, USA
Statement of IntentPage—Boilerplate Text
The text below is not included in the Blue Book template because it is not applicable to the book when it is in its White and Red Book stages. It is provided here for informational purposes only.
Per section 3.3.4 of the Publications Manual:The exact text of the Statement of Intent is[4]:
The Consultative Committee for Space Data Systems (CCSDS) is an organization officially established by the management of its members. The Committee meets periodically to address data systems problems that are common to all participants, and to formulate sound technical solutions to these problems. Inasmuch as participation in the CCSDS is completely voluntary, the results of Committee actions are termed Recommended Standards and are not considered binding on any Agency.This Recommended Standard is issued by, and represents the consensus of, the CCSDS members. Endorsement of this Recommendation is entirely voluntary. Endorsement, however, indicates the following understandings:
oWhenever a member establishes a CCSDS-related standard, this standard will be in accord with the relevant Recommended Standard. Establishing such a standard does not preclude other provisions which a member may develop.
oWhenever a member establishes a CCSDS-related standard, that member will provide other CCSDS members with the following information:
--The standard itself.
--The anticipated date of initial operational capability.
--The anticipated duration of operational service.
oSpecific service arrangements shall be made via memoranda of agreement. Neither this Recommended Standard nor any ensuing standard is a substitute for a memorandum of agreement.
No later than three years from its date of issuance, this Recommended Standard will be reviewed by the CCSDS to determine whether it should: (1) remain in effect without change; (2) be changed to reflect the impact of new technologies, new requirements, or new directions; or (3) be retired or canceled.
In those instances when a new version of a Recommended Standard is issued, existingCCSDS-related member standards and implementations are not negated or deemed to benon-CCSDS compatible. It is the responsibility of each member to determine when suchstandards or implementations are to be modified. Each member is, however, strongly encouraged to direct planning for its new standards and implementations towards the later version of the Recommended Standard.
Foreword
The Blue Book template provides the boilerplate text for the Foreword. The Foreword contains the following:
1. Technical Content;
2.A boilerplate patent rights disclaimer when no patent rights are known to appertain; however, if patent rights have been identified during the preparation of the Blue Book, a “Patented Technologies” section must be included in the Introduction;
3.Boilerplate textstating that the document may evolve and change;
4. An up-to-date list of CCSDS Member and Observer Agencies.
Technical Content
The intended use and audience for the document shall be identified in the foreword.(The technical editor provides the content.)
Patent Rights Disclaimer (if there are no known patent rights)
In Recommended Standards and Experimental Specifications to which no patent rights are known to appertain, the following patent rights disclaimer text shall follow the technical content of the foreword:
Attention is drawn to the possibility that some of the elements of this document may be the subject of patent rights. CCSDS shall not be held responsible for identifying any or all such patent rights.Document Evolution Boilerplate Text[5]
For all documents, the following boilerplate text shall follow the technical content of the foreword and, if present, the patent rights disclaimer:
Through the process of normal evolution, it is expected that expansion, deletion, or modification of this document may occur. This document is therefore subject to CCSDS document management and change control procedures which are defined in Organization and Processes for the Consultative Committee for Space Data Systems(CCSDS A02.1-Y-3).Current versions of CCSDS documents are maintained at the CCSDS Web site:Questions relating to the contents or status of this document should be addressed to the CCSDS Secretariat at the address indicated on page i.
List of Member and Observer Agencies
The mandatory text and agency lists are on the following page.
Member Agencies
Agenzia Spaziale Italiana (ASI)/Italy.
Canadian Space Agency (CSA)/Canada.
Centre National d’Etudes Spatiales (CNES)/France.
China National Space Administration (CNSA)/People’s Republic of China.
Deutsches Zentrum für Luft- und Raumfahrt e.V. (DLR)/Germany.
European Space Agency (ESA)/Europe.
Federal Space Agency (FSA)/Russian Federation.
Instituto Nacional de Pesquisas Espaciais (INPE)/Brazil.
Japan Aerospace Exploration Agency (JAXA)/Japan.
National Aeronautics and Space Administration (NASA)/USA.
UK Space Agency/United Kingdom.
Observer Agencies
Austrian Space Agency (ASA)/Austria.
Belgian Federal Science Policy Office (BFSPO)/Belgium.
Central Research Institute of Machine Building (TsNIIMash)/Russian Federation.
China Satellite Launch and Tracking Control General, Beijing Institute of Tracking and Telecommunications Technology (CLTC/BITTT)/China.
Chinese Academy of Sciences (CAS)/China.
Chinese Academy of Space Technology (CAST)/China.
Commonwealth Scientific and Industrial Research Organization (CSIRO)/Australia.
Danish National Space Center (DNSC)/Denmark.
Departamento de Ciência e Tecnologia Aeroespacial (DCTA)/Brazil.
European Organization for the Exploitation of Meteorological Satellites (EUMETSAT)/Europe.
European Telecommunications Satellite Organization (EUTELSAT)/Europe.
Geo-Informatics and Space Technology Development Agency (GISTDA)/Thailand.
Hellenic National Space Committee (HNSC)/Greece.
Indian Space Research Organization (ISRO)/India.
Institute of Space Research (IKI)/Russian Federation.
KFKI Research Institute for Particle & Nuclear Physics (KFKI)/Hungary.
Korea Aerospace Research Institute (KARI)/Korea.
Ministry of Communications (MOC)/Israel.
National Institute of Information and Communications Technology (NICT)/Japan.
National Oceanic and Atmospheric Administration (NOAA)/USA.
National Space Agency of the Republic of Kazakhstan (NSARK)/Kazakhstan.
National Space Organization (NSPO)/Chinese Taipei.
Naval Center for Space Technology (NCST)/USA.
Scientific and Technological Research Council of Turkey (TUBITAK)/Turkey.
South African National Space Agency (SANSA)/Republic of South Africa.
Space and Upper Atmosphere Research Commission (SUPARCO)/Pakistan.
Swedish Space Corporation (SSC)/Sweden.
United States Geological Survey (USGS)/USA.
Preface
A preface is required in DRAFTS of Blue Books (i.e., White Books and Red Books).
REMINDER (repeat of footnote on page 2): A preface is not normally included in final publications but may be included to provide issue-specific information.
White Book Preface Boilerplate Text[6]
TheWhite Book Preface text below is already in the Blue Book template; it will need to be changed for the Red Book and will be removed from the Blue Book before publication.
This document is a draft CCSDS Recommended Standard. Its ‘White Book’ status indicates that its contents are not stable, and several iterations resulting in substantial technical changes are likely to occur before it is considered to be sufficiently mature to be released for review by the CCSDS Agencies.Implementers are cautioned not to fabricate any final equipment in accordance with this document’s technical content.
Recipients of this draft are invited to submit, with their comments, notification of any relevant patent rights of which they are aware and to provide supporting documentation.
Red Book Preface Boilerplate Text
The text of the preface for draft CCSDS Recommended Standards shall be:
This document is a draft CCSDS Recommended Standard. Its ‘Red Book’ status indicates that the CCSDS believes the document to be technically mature and has released it for formal review by appropriate technical organizations. As such, its technical contents are not stable, and several iterations of it may occur in response to comments received during the review process.Implementers are cautioned notto fabricate any final equipment in accordance with this document’s technical content.
Recipients of this draft are invited to submit, with their comments, notification of any relevant patent rights of which they are aware and to provide supporting documentation.
Document Control
The template includes a Document Control page with the format already set up. The document control section shall contain a history of the published issues of the document.
The following entries shall be made for each issue of the book, including the current issue:
a)document number;
b)title and issue;
c)issue date;
d)summary of changes; (if appropriate, changes shall be listed in two categories:
changes not compatible with the previous issue; and
changes compatible with the previous issue.
Section 1 (Introduction) Particulars
(Repeated from earlier):The introduction of the document shall identify and define the document, present conventions used in and definitions specific to the document, and provide a list of referenced documents.
Definitions
The Definitions section may include the subsections of Terms, Nomenclature, and Conventions. The Nomenclature section is mandatory; the other two should be provided if needed.
Terms
Terms specific to the document must be listed.The text used to introduce the list of terms shall be:
For the purposes of this documentthe following definitions apply.Generally, the CCSDS definition format follows that of the definition of terse style, as shown below:
terse style:Style of specification in which normal text is limited to concise statements of requirements. Discussions concerning rationale, background, and other ancillary topics are constrained to be brief and are set off from normal text, usually in a note, or sometimes in a subsection that is clearly labeled as being non-normative.
Detailed formatting guidance for definitions is provided in 3.4.1.6 of the Publications Manual.Due to its “editorial pitfall” nature, some of that guidance was emphasized in the April 2013 Technical Editor Boot Camp slides. Highlighted in the boot camp were the following items: