Web Annotation Data Model (WADM) Documentation - bounswe/bounswe2024group12 GitHub Wiki

1. Purpose and Benefits

Purpose: The Web Annotation Data Model (WADM) provides a structured, standardized way to attach comments to various types of content within our project, including specific chess moves, posts, games, players, and tournaments. By using WADM, we ensure that each comment is accurately linked to its relevant content, making discussions clear and organized.

Benefits:

  • Enhanced User Engagement: Users can add precise comments to individual moves, encouraging detailed analysis and focused discussions.
  • Structured Data: WADM’s JSON-LD format organizes data, making it easier to handle in the application and potentially interoperable with other systems.
  • Future Compatibility: Using a W3C standard like WADM means that the forum’s annotation system aligns with established web practices, supporting long-term maintenance and scalability.

2. Requirements of Following the Standard

To use WADM effectively in our chess forum, the following requirements should be met:

  • Annotation Structure: Each comment should follow the WADM structure, including fields like @context, type, body, and target.
    • @context: Must be set to "http://www.w3.org/ns/anno.jsonld" to specify that the annotation is WADM-compliant.
    • type: Set to "Annotation".
    • body: Contains the actual comment.
    • target: Defines the specific move the comment refers to, using the FEN notation of the move in a FragmentSelector.
  • Unique Identifiers: Each annotation must have a unique id for reference and retrieval.
  • Creator Information: The user who makes the comment should be identified in the creator field to ensure proper attribution and support accountability.
  • Motivation: For move comments, the motivation should generally be set to "commenting".

3. Enforcement in Practice

To ensure consistent and correct usage of WADM across our forum, the following practices will be enforced:

  • Integration: The frontend and mobile will be developed with the expectation that all annotations follow the WADM standard. The backend will ensure compliance with this standard, sending annotations in the correct format to the frontend and mobile. This consistent implementation across all teams will facilitate seamless interactions and prevent compatibility issues.
  • Code Reviews: All annotations will be reviewed to ensure they follow the WADM structure, with required fields and correct format.
  • Documentation and Training: Clear instructions and examples will be provided to team members to maintain consistent implementation, with a focus on common fields and their purpose.