Bug 327 - INPE-2: Cross-reference glossary term to first use
Summary: INPE-2: Cross-reference glossary term to first use
Status: RESOLVED NO CHANGE MADE
Alias: None
Product: OAIS June 2012
Classification: Unclassified
Component: Section 1: Introduction (show other bugs)
Version: June 2012
Hardware: No All
: --- Editorial
Assignee: David Giaretta (david@giaretta.org)
URL:
Whiteboard:
Depends on:
Blocks:
 
Reported: 2021-01-19 10:59 UTC by David Giaretta (david@giaretta.org)
Modified: 2021-04-06 20:35 UTC (History)
4 users (show)

See Also:
Organisation of the submitter: INPE
Disposition of the suggested change:
Category of the suggested change: ---
Due date:
Explanation of the reason for the suggested change:
The author of this proposal, for transforming it in a Brazilian Standard (ABNT/BR) had to translate to the Portuguese the previous OAIS document ISO 14721:2012, which contains the document CCSDS 650.0-M-2. The proposal being made in this current RID has the intention to significantly facilitate the reader in identifying in what context of the document the term is introduced for the first time, in the text. This simple practice does help a lot in the understanding of the document, as whole, considering that the document is complex by nature for making use of a wide variety of terms, some of them, not so easily or readily understandable.


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description David Giaretta (david@giaretta.org) 2021-01-19 10:59:23 UTC
AGENCY RID NUMBER:02/03
SUBMITTING ORGANIZATION(Agency,Center): INPE 
------------------------------------------------------------------
REVIEWER'S NAME: Eduardo.W.Bergamini  
CODE:RME/CORCR/INPE             
E-MAIL ADDRESS:eduardo.w.bergamini@outlook.com     
TELEPHONE: + 55 12 3208 6166/6603         
------------------------------------------------------------------
DOCUMENT NUMBER:   CCSDS 650.0-P-2.1 RP 20-25 
DOCUMENT NAME: Ref. Model for an Open Archival Information System     
DATE ISSUED: October 2020
PAGE NUMBER: 1-8              PARAGRAPH NUMBER: Sub-section 1.6.2 
RID SHORT TITLE: Tagged Terminology   
------------------------------------------------------------------
DESCRIPTION OF REQUESTED CHANGE:(Use From: "..." To "..." format)

It is proposed that in Sub-section 1.6.2 Terminology, for EACH 
term which is defined, that number of the specific Sub-section (eventually, the number of a Section itself, if the case) or if 
the case, the capital letter of an Annex, where the term, in 
general, is presented for the FIRST time in the text of the 
document, that it may be conveniently INSERTED, possibly in parenthesis, in the content which defines the term, therefore, 
tagging it with the addition of the mentioned information.  
 
JUSTIFICATION: The author of this proposal, for transforming it in 
a Brazilian Standard (ABNT/BR) had to translate to the Portuguese
the previous OAIS document ISO 14721:2012, which contains the 
document CCSDS 650.0-M-2. The proposal being made in this current 
RID has the intention to significantly facilitate the reader in identifying in what context of the document the term is introduced
for the first time, in the text. This simple practice does help a 
lot in the understanding of the document, as whole, considering
that the document is complex by nature for making use of a wide variety of terms, some of them, not so easily or readily understandable.

------------------------------------------------------------------
CATEGORY OF REQUESTED CHANGE:
     Technical Fact ___    Recommended X    Editorial X
NOTES:
TECHNICAL FACT:  Major technical change of sufficient magnitude as to
 render the Recommendation inaccurate and unacceptable if not
 corrected.  (Supporting analysis/rationale is essential.)
RECOMMENDED:  Change of a nature that would, if incorporated, produce
 a marked improvement in document quality and acceptance.
EDITORIAL:  Typographical or other factual error needing correction.
 (This type of change will be made without feedback to submitter.)
------------------------------------------------------------------
SUPPORTING ANALYSIS:



------------------------------------------------------------------
DISPOSITION:
Comment 1 David Giaretta (david@giaretta.org) 2021-02-23 11:59:36 UTC
This would be fairly easy to do. 
My only concern is that sometimes the first mention of the term does not provide any detailed information.
I wonder if an index might help more? If that is allowed by the CCSDS Publications Manual.
Comment 2 Mark Conrad (mark.conrad.iso@gmail.com) 2021-03-08 17:06:11 UTC
(In reply to David Giaretta from comment #1)
> This would be fairly easy to do. 
> My only concern is that sometimes the first mention of the term does not
> provide any detailed information.
> I wonder if an index might help more? If that is allowed by the CCSDS
> Publications Manual.

Hyperlinks from each use of the term to its definition would be ideal, but I am almost positive this is not allowed by the CCSDS Publications Manual.
Comment 3 David Giaretta (david@giaretta.org) 2021-03-09 11:24:29 UTC
(In reply to Mark Conrad from comment #2)
> (In reply to David Giaretta from comment #1)
> > This would be fairly easy to do. 
> > My only concern is that sometimes the first mention of the term does not
> > provide any detailed information.
> > I wonder if an index might help more? If that is allowed by the CCSDS
> > Publications Manual.
> 
> Hyperlinks from each use of the term to its definition would be ideal, but I
> am almost positive this is not allowed by the CCSDS Publications Manual.

I don't see anything specifically against this in the CCSDS Publications Manual but I have asked the CCSDS Editor.
Comment 4 David Giaretta (david@giaretta.org) 2021-03-22 17:47:14 UTC
CCSDS Editor's advice is to not do this since simple search will be better
Comment 5 David Giaretta (david@giaretta.org) 2021-03-30 10:42:10 UTC
DAI20210323 Agreed with advice from CCSDS editor:

Since this is a standards organization and we should resist introducing ad-hoc stylistic elements into standards. 

He also noted that a simple text search would serve this purpose.
Comment 6 David Giaretta (david@giaretta.org) 2021-03-30 10:43:19 UTC
DAI20210323 Agreed with advice from CCSDS editor:

Since this is a standards organization and we should resist introducing ad-hoc stylistic elements into standards. 

He also noted that a simple text search would serve this purpose.

@Eduardo: Please confirm that this is acceptable by email to david@giaretta.org
Comment 7 David Giaretta (david@giaretta.org) 2021-04-06 07:51:30 UTC
(In reply to David Giaretta from comment #6)
> DAI20210323 Agreed with advice from CCSDS editor:
> 
> Since this is a standards organization and we should resist introducing
> ad-hoc stylistic elements into standards. 
> 
> He also noted that a simple text search would serve this purpose.
> 
> @Eduardo: Please confirm that this is acceptable by email to
> david@giaretta.org

Eduardo Bergamini (eduardo.w.bergamini@outlook.com)  2021-04-05 24:00:00 UTC                                                                                                                                             Comment 2 (?)

COMMENT: INPE is not in a condition to perform this task as a result of the pandemic related home-office regime which is in practice in INPE since last year. There is no sufficient human resource for performing  this specific task as it would be required. It would not be fairly easy to do in the OAIS document because it is very complex, complying a very long list of definition of terms which, would have to be cared for. Indeed, Indeed, CCSDS Publications Manual would have to be analysed to be sure what would be the appropriate editorial procedure for such an upgrade in the OAIS document. Quite a task, any way, which requires quite attention and care for, in terms of cross-reference.
Comment 8 Eduardo Bergamini (eduardo.w.bergamini) 2021-04-06 20:34:10 UTC
In view of the content presented in the above COMMENT 7, this reviewer accept the terms proposed by CCSDS Editor. However, this reviewer is much aware of the hard time that had to be faced when translating a document close to this current one (that is, the previous version of the OAIS doc.), in this case, for producing a "local", strictly equivalent standard (correspondent to the ISO standard one, for ABNT/Brazil, feeling it very closely that it would be -very- convenient for the potential reader to learn what is the meaning of the term when it is met for the 1st time, in the text. For this reason, this reviewer is convinced that it would be very convenient that when a term is mentioned for the 1st. time in the text, be it with a "local" definition, or not, that a text like ... (See definition of this term in Subsection 1.6.2) .. or like ... (See 1.6.2) ... or else ... may be appended just after the associated term. It is also noted that in translating such a type of document (the previous version of the OAS doc.) this reviewer also found a considerable number of terms that would have deserved also to be defined in the corresponding Subsection like that of the current Subsection "1.6.2 TERMINOLOGY". The reason for this pondering is that (at least) the previous OAIS document was very rich in terms that did deserve a definition to be resident in a Subsection like the current Subsection 1.6.2, but that had not been defined, in some cases, at all ... 

Thank you for the opportunity to submit this comment.
Comment 9 Eduardo Bergamini (eduardo.w.bergamini) 2021-04-06 20:35:13 UTC
In view of the content presented in the above COMMENT 7, this reviewer accept the terms proposed by CCSDS Editor. However, this reviewer is much aware of the hard time that had to be faced when translating a document close to this current one (that is, the previous version of the OAIS doc.), in this case, for producing a "local", strictly equivalent standard (correspondent to the ISO standard one, for ABNT/Brazil, feeling it very closely that it would be -very- convenient for the potential reader to learn what is the meaning of the term when it is met for the 1st time, in the text. For this reason, this reviewer is convinced that it would be very convenient that when a term is mentioned for the 1st. time in the text, be it with a "local" definition, or not, that a text like ... (See definition of this term in Subsection 1.6.2) .. or like ... (See 1.6.2) ... or else ... may be appended just after the associated term. It is also noted that in translating such a type of document (the previous version of the OAS doc.) this reviewer also found a considerable number of terms that would have deserved also to be defined in the corresponding Subsection like that of the current Subsection "1.6.2 TERMINOLOGY". The reason for this pondering is that (at least) the previous OAIS document was very rich in terms that did deserve a definition to be resident in a Subsection like the current Subsection 1.6.2, but that had not been defined, in some cases, at all ... 

Thank you for the opportunity to submit this comment.