Issue 541: Small Edits Checklist

ID: 
541
Starting Date: 
2021-06-02
Working Group: 
4
Status: 
Open
Background: 

Post by Philippe Michon on June 6, 2021: 

Currently, there is no formal process to identify small errors and/or typos in the CIDOC CRM documentation. If a user notices, for example, a spelling mistake in the text, two options seem possible:

  • Write an email for an editor to correct the mistake;

  • Create a dedicated issue. 

Both options seem not quite adequate: on the one hand, sending an email can discourage those who are not familiar with the structure of the SIG and, on the other hand, the issues should be used for substantive discussions rather than for minor edits.

For this reason, should we put in place a tool that would allow anyone to identify minor errors in the CIDOC CRM documentation and which would also be used by editors to follow up? If so, do we think a spreadsheet with a structure similar to this would be a good place to start? Note that this document is currently hosted on the Canadian Heritage Information Network's Google Drive, but if everyone agrees this is relevant, it should be hosted by the SIG.

In the context of this issue, I would particularly like to obtain your comments on the following questions:

  1. Should this be implemented?

  2. Does this type of tool/document seem relevant to us?

  3. Do we like the current structure or would it be better to make some changes?

  4. How should we make this document accessible? Is one link in this issue sufficient?

  5. Regardless of where the document is published, would it be relevant to present the objectives and a tutorial on how to use this document in a few paragraphs?

  6. Any other questions to discuss?

 

Kind regards,

Philippe

Post by Pat Riva (15 June 2021)

I agree with Philippe that a tracking tool for small edits is a good idea. In my experience translation projects do tend to notice all these small imperfections in the source document. The translator has to figure out what was meant to do the translation. If there is no quick way to document them, it is easy to lose the opportunity to make the corrections.

 

There are also likely to be similar small editorial points discovered in the extensions, and eventually also in the translations. If the same file is shared, it will need a column to indicate which model and which language. Or there could be distinct files along the same pattern.

 

Pat

In the 50th joint meeting of the CIDOC CRM SIG and SO/TC46/SC4/WG9; 43nd FRBR – CIDOC CRM Harmonization meeting,  the SIG reviewed HW by PM (spreadsheet for listing typos and formatting inconsistencies in CIDOC CRM v7.1.1).

Decision:

  • checklists must be implemented periodically and a guideline on how they're to be kept up to date must be incorporated in GBs HW for issue 354. 
  • this particular checklist to appear on the website

June 2021

Post by George Bruseker (7 October 2021)

Dear all,

In this HW I was charged with: 

"checklists must be implemented periodically and a guideline on how they're to be kept up to date must be incorporated in GBs HW for issue 354.

this particular checklist to appear on the website"

 

It is my proposal that this document appear in the proposed new guidelines and translations resources sections of the overall reconfigured resources section of the SIG website.

( see last sentence of HW 528 proposal)

https://docs.google.com/document/d/1BiGrX_pieVCCwlNf-JQweHkwTp57mfY58SIPxBvwkhw/edit

 

For your consideration.

Best,

George

Reference to Issues: