Project

General

Profile

Feature #1751

Manual: add model documentation

Added by Nina Richards 4 months ago. Updated 4 days ago.

Status:
Closed
Priority:
Normal
Assignee:
Category:
Documentation
Target version:
Start date:
2022-08-29
Estimated time:
(Total: 0.00 h)

Description

As I add CIDOC CRM classes to the manual at the moment I was wondering if there is documentation for the shortcuts OA8 (begins in) and OA9 (ends in) that I can link to? I was not able to find anything on the model page (https://thanados.openatlas.eu/overview/model) nor the OpenAtlas class index (https://thanados.openatlas.eu/overview/model/openatlas_class_index). If there is nothing like that yet, should we add the information somewhere?

Furthermore, in the archaeological hierarchy model (https://thanados.openatlas.eu/static/images/model/openatlas_schema2.png) E22 is named man-made object (artifact) while E22 is actually named Human-Made Object according to the CIDOC CRM definitions 7.1.1. Maybe we should update this as well?


Subtasks

Question #1795: Manual: Model possible mistakeClosedStefan EichertActions

Related issues

Related to Feature #1701: API: documentationIn Progress2022-04-27Actions

History

#1

Updated by Alexander Watzinger 4 months ago

  • Category set to UI
  • Status changed from New to In Progress
  • Assignee set to Nina Richards

As for documentation of CIDOC shortcuts we are using, you find them here: https://redmine.openatlas.eu/projects/uni/wiki/CIDOC_CRM_shortcuts
But before linking this in the manual you should definitely check with Stefan, who is documenting these, before.

Just to be save we might should consider adding these texts to the manual as a precaution to prevent outdated links in the future.

As for the wrong label for E22 in the model image: thanks for reporting, I fixed it in develop.

#2

Updated by Nina Richards 3 months ago

I checked in with Stefan this morning and according to him, the OA shortcuts are still up to date. So, if that's okay for everyone, I would put a short text about them into the manual next time I'm working on it and provide links where fitting in the manual.

#3

Updated by Alexander Watzinger 3 months ago

#4

Updated by Alexander Watzinger 3 months ago

  • Tracker changed from Question to Feature
  • Subject changed from OpenAtlas Shortcuts OA8 and OA9 to Model documentation in manual
  • Target version set to 7.5.0
As mentioned before I would suggest moving the 4 Redmine Model and concept pages as a whole to the manual which would have multiple advantages:
  • Better readability and accessibility
  • Documentation is always corresponding to used software version
  • No danger of outdated links to Redmine

As for implementation I would suggest a new main menu item Model and merging there the existing manual model page and the first Redmine page OpenAtlas_and_CIDOC_CRM, with the other sites as sub pages.
After this move we could do the same with the API documentation and so would have a clean separation with the manual as central documentation and Redmine for planning (issues, roadmap) and operative (e.g. online versions) related information.

Thank you very much for taking care of this. Although very important, the model documentation was done around 2020 and (beside minor cosmetic updates from me) not actively maintained.

#5

Updated by Alexander Watzinger about 2 months ago

  • Category changed from UI to Documentation
#6

Updated by Alexander Watzinger about 2 months ago

  • Target version changed from 7.5.0 to 7.7.0
#7

Updated by Alexander Watzinger about 1 month ago

  • Subject changed from Model documentation in manual to Manual: add model documentation
#8

Updated by Stefan Eichert about 1 month ago

The shortcuts are described in the archive: https://redmine.craws.net/projects/uni/wiki/CIDOC-Mappings

#9

Updated by Nina Richards about 1 month ago

  • Status changed from In Progress to Resolved
#10

Updated by Alexander Watzinger about 1 month ago

  • Status changed from Resolved to In Progress

There seem to be still dates and references model documentation missing, see: https://redmine.openatlas.eu/projects/uni/wiki/Model_and_concept
But it looks very nice already and I'm looking forward to it. Thank you for time and effort.

#11

Updated by Nina Richards 5 days ago

  • Status changed from In Progress to Resolved
#12

Updated by Nina Richards 4 days ago

  • Status changed from Resolved to Closed

Also available in: Atom PDF