Skip to content

add documentation for the assessment schema#57

Open
fdiblen wants to merge 6 commits intomainfrom
assessment_docs
Open

add documentation for the assessment schema#57
fdiblen wants to merge 6 commits intomainfrom
assessment_docs

Conversation

@fdiblen
Copy link
Copy Markdown
Contributor

@fdiblen fdiblen commented Dec 8, 2025

This PR adds documentation for the assessment schema.

Ref:

Note: I set the version as 0.0.2 to be consistent with the other schemas. If you prefer to keep 0.0.1, I can revert that.

@fdiblen fdiblen requested a review from dgarijo December 8, 2025 11:05
@vuillaut
Copy link
Copy Markdown
Contributor

This LGTM - does @dgarijo want to have a look?

Concerning the versioning, it's actually unclear how we version the different schemas in this repo. They are now aligned, but it's more by chance I think. It's ok to always keep them aligned but it should be clarified (i'll open an issue now).

Copy link
Copy Markdown
Contributor

@dgarijo dgarijo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Small requests.

"@id": "https://w3id.org/everse/rsqa#",
"@type": "owl:Ontology",
"dcterms:creator": [
"Faruk Diblen",
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In theory this should be an object (i.e., something with name and id), not a string

"rdfs:label": "check evidence",
"rdfs:comment": "Additional information or evidence on how the check status was concluded.",
"rdfs:domain": { "@id": "rsqa:CheckResult" },
"rdfs:range": { "@id": "xsd:string" }
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"rdfs:range": { "@id": "xsd:string" }
"rdfs:range": { "@id": "schema:Text" }

"rdfs:label": "check output",
"rdfs:comment": "The raw output or result value of the check.",
"rdfs:domain": { "@id": "rsqa:CheckResult" },
"rdfs:range": { "@id": "xsd:string" }
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"rdfs:range": { "@id": "xsd:string" }
"rdfs:range": { "@id": "schema:Text" }

"@id": "rsqa:SoftwareQualityAssessment",
"@type": "rdfs:Class",
"rdfs:label": "Software Quality Assessment",
"rdfs:comment": "A software quality assessment represents the result of measured indicators for a piece of software."
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"rdfs:comment": "A software quality assessment represents the result of measured indicators for a piece of software."
"rdfs:comment": "A software quality assessment represents the result of measuring a set of indicators for a piece of software. The result is a set of rsqa:CheckResults"

@dgarijo
Copy link
Copy Markdown
Contributor

dgarijo commented Feb 10, 2026

I clarified a definition, the rest are small cosmetic things that maybe we should consider for consistency. Maybe this implies me going over the other schemas checking the small stuff too.
The context and example are nicely designed.

fdiblen and others added 3 commits February 18, 2026 23:19
Co-authored-by: Daniel Garijo <dgarijov@gmail.com>
Co-authored-by: Daniel Garijo <dgarijov@gmail.com>
Co-authored-by: Daniel Garijo <dgarijov@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants