Changes for page Requirements

Last modified by Robert Schaub on 2025/12/24 21:46

From version 3.1
edited by Robert Schaub
on 2025/12/19 09:57
Change comment: There is no comment for this version
To version 6.1
edited by Robert Schaub
on 2025/12/19 10:28
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -6,7 +6,7 @@
6 6  
7 7  == Navigation ==
8 8  
9 -* **[[User Needs>>FactHarbor.Specification.Requirements.User-Needs]]** - What users need from FactHarbor (drives these requirements)
9 +* **[[User Needs>>FactHarbor.Specification.Requirements.User Needs.WebHome]]** - What users need from FactHarbor (drives these requirements)
10 10  * **This page** - How we fulfill those needs through system design
11 11  
12 12  (% class="box infomessage" %)
... ... @@ -13,7 +13,7 @@
13 13  (((
14 14  **How to read this page:**
15 15  
16 -1. **User Needs drive Requirements**: See [[User Needs>>FactHarbor.Specification.Requirements.User-Needs]] for what users need
16 +1. **User Needs drive Requirements**: See [[User Needs>>FactHarbor.Specification.Requirements.User Needs.WebHome]] for what users need
17 17  2. **Requirements define implementation**: This page shows how we fulfill those needs
18 18  3. **Functional Requirements (FR)**: Specific features and capabilities
19 19  4. **Non-Functional Requirements (NFR)**: Quality attributes (performance, security, etc.)
... ... @@ -42,7 +42,7 @@
42 42  * Modify content
43 43  * Access edit history details
44 44  
45 -**User Needs served**: UN-1 (Trust assessment), UN-2 (Claim verification), UN-3 (Article summary with FactHarbor analysis summary), UN-4 (Social media fact-checking), UN-5 (Source tracing), UN-7 (Evidence transparency), UN-8 (Understanding disagreement), UN-12 (Submit claims)
45 +**User Needs served**: UN-1 (Trust assessment), UN-2 (Claim verification), UN-3 (Article summary with FactHarbor analysis summary), UN-4 (Social media fact-checking), UN-5 (Source tracing), UN-7 (Evidence transparency), UN-8 (Understanding disagreement), UN-12 (Submit claims), UN-17 (In-article highlighting)
46 46  
47 47  === 1.2 Contributor ===
48 48  
... ... @@ -481,6 +481,168 @@
481 481  * Exportable as standalone summary report
482 482  * Shareable via permanent URL
483 483  
484 +==== FR13 — In-Article Claim Highlighting ====
485 +
486 +**Fulfills**: UN-17 (In-article claim highlighting)
487 +
488 +**Purpose**: Enable readers to quickly assess claim credibility while reading by visually highlighting factual claims with color-coded indicators
489 +
490 +==== Visual Example: Article with Highlighted Claims ====
491 +
492 +(% class="box" %)
493 +(((
494 +**Article: "New Study Shows Benefits of Mediterranean Diet"**
495 +
496 +A recent study published in the Journal of Nutrition has revealed new findings about the Mediterranean diet.
497 +
498 +(% class="box successmessage" style="margin:10px 0;" %)
499 +(((
500 +🟢 **Researchers found that Mediterranean diet followers had a 25% lower risk of heart disease compared to control groups**
501 +
502 +(% style="font-size:0.9em; color:#666;" %)
503 +↑ WELL SUPPORTED • 87% confidence
504 +[[Click for evidence details →]]
505 +(%%)
506 +)))
507 +
508 +The study, which followed 10,000 participants over five years, showed significant improvements in cardiovascular health markers.
509 +
510 +(% class="box warningmessage" style="margin:10px 0;" %)
511 +(((
512 +🟡 **Some experts believe this diet can completely prevent heart attacks**
513 +
514 +(% style="font-size:0.9em; color:#666;" %)
515 +↑ UNCERTAIN • 45% confidence
516 +Overstated - evidence shows risk reduction, not prevention
517 +[[Click for details →]]
518 +(%%)
519 +)))
520 +
521 +Dr. Maria Rodriguez, lead researcher, recommends incorporating more olive oil, fish, and vegetables into daily meals.
522 +
523 +(% class="box errormessage" style="margin:10px 0;" %)
524 +(((
525 +🔴 **The study proves that saturated fats cause heart disease**
526 +
527 +(% style="font-size:0.9em; color:#666;" %)
528 +↑ REFUTED • 15% confidence
529 +Claim not supported by study design; correlation ≠ causation
530 +[[Click for counter-evidence →]]
531 +(%%)
532 +)))
533 +
534 +Participants also reported feeling more energetic and experiencing better sleep quality, though these were secondary measures.
535 +)))
536 +
537 +**Legend:**
538 +* 🟢 = Well-supported claim (confidence ≥75%)
539 +* 🟡 = Uncertain claim (confidence 40-74%)
540 +* 🔴 = Refuted/unsupported claim (confidence <40%)
541 +* Plain text = Non-factual content (context, opinions, recommendations)
542 +
543 +==== Tooltip on Hover/Click ====
544 +
545 +(% class="box infomessage" %)
546 +(((
547 +**FactHarbor Analysis**
548 +
549 +**Claim:**
550 +"Researchers found that Mediterranean diet followers had a 25% lower risk of heart disease"
551 +
552 +**Verdict:** WELL SUPPORTED
553 +**Confidence:** 87%
554 +
555 +**Evidence Summary:**
556 +* Meta-analysis of 12 RCTs confirms 23-28% risk reduction
557 +* Consistent findings across multiple populations
558 +* Published in peer-reviewed journal (high credibility)
559 +
560 +**Uncertainty Factors:**
561 +* Exact percentage varies by study (20-30% range)
562 +
563 +[[View Full Analysis →]]
564 +)))
565 +
566 +**Color-Coding System**:
567 +* **Green**: Well-supported claims (confidence ≥75%, strong evidence)
568 +* **Yellow/Orange**: Uncertain claims (confidence 40-74%, conflicting or limited evidence)
569 +* **Red**: Refuted or unsupported claims (confidence <40%, contradicted by evidence)
570 +* **Gray/Neutral**: Non-factual content (opinions, questions, procedural text)
571 +
572 +==== Interactive Highlighting Example (Detailed View) ====
573 +
574 +(% style="width:100%; border-collapse:collapse;" %)
575 +|=**Article Text**|=**Status**|=**Analysis**
576 +|(((A recent study published in the Journal of Nutrition has revealed new findings about the Mediterranean diet.)))|(% style="text-align:center;" %)Plain text|(% style="font-style:italic; color:#888;" %)Context - no highlighting
577 +|(((//Researchers found that Mediterranean diet followers had a 25% lower risk of heart disease compared to control groups//)))|(% style="background-color:#D4EDDA; text-align:center; padding:8px;" %)🟢 **WELL SUPPORTED**|(((
578 +**87% confidence**
579 +
580 +Meta-analysis of 12 RCTs confirms 23-28% risk reduction
581 +
582 +[[View Full Analysis]]
583 +)))
584 +|(((The study, which followed 10,000 participants over five years, showed significant improvements in cardiovascular health markers.)))|(% style="text-align:center;" %)Plain text|(% style="font-style:italic; color:#888;" %)Methodology - no highlighting
585 +|(((//Some experts believe this diet can completely prevent heart attacks//)))|(% style="background-color:#FFF3CD; text-align:center; padding:8px;" %)🟡 **UNCERTAIN**|(((
586 +**45% confidence**
587 +
588 +Overstated - evidence shows risk reduction, not prevention
589 +
590 +[[View Details]]
591 +)))
592 +|(((Dr. Rodriguez recommends incorporating more olive oil, fish, and vegetables into daily meals.)))|(% style="text-align:center;" %)Plain text|(% style="font-style:italic; color:#888;" %)Recommendation - no highlighting
593 +|(((//The study proves that saturated fats cause heart disease//)))|(% style="background-color:#F8D7DA; text-align:center; padding:8px;" %)🔴 **REFUTED**|(((
594 +**15% confidence**
595 +
596 +Claim not supported by study; correlation ≠ causation
597 +
598 +[[View Counter-Evidence]]
599 +)))
600 +
601 +**Design Notes:**
602 +* Highlighted claims use italics to distinguish from plain text
603 +* Color backgrounds match XWiki message box colors (success/warning/error)
604 +* Status column shows verdict prominently
605 +* Analysis column provides quick summary with link to details
606 +
607 +**User Actions**:
608 +* **Hover** over highlighted claim → Tooltip appears
609 +* **Click** highlighted claim → Detailed analysis modal/panel
610 +* **Toggle** button to turn highlighting on/off
611 +* **Keyboard**: Tab through highlighted claims
612 +
613 +**Interaction Design**:
614 +* Hover/click on highlighted claim → Show tooltip with:
615 + * Claim text
616 + * Verdict (e.g., "WELL SUPPORTED")
617 + * Confidence score (e.g., "85%")
618 + * Brief evidence summary
619 + * Link to detailed analysis
620 +* Toggle highlighting on/off (user preference)
621 +* Adjustable color intensity for accessibility
622 +
623 +**Technical Requirements**:
624 +* Real-time highlighting as page loads (non-blocking)
625 +* Claim boundary detection (start/end of assertion)
626 +* Handle nested or overlapping claims
627 +* Preserve original article formatting
628 +* Work with various content formats (HTML, plain text, PDFs)
629 +
630 +**Performance Requirements**:
631 +* Highlighting renders within 500ms of page load
632 +* No perceptible delay in reading experience
633 +* Efficient DOM manipulation (avoid reflows)
634 +
635 +**Accessibility**:
636 +* Color-blind friendly palette (use patterns/icons in addition to color)
637 +* Screen reader compatible (ARIA labels for claim credibility)
638 +* Keyboard navigation to highlighted claims
639 +
640 +**Implementation Notes**:
641 +* Claims extracted and analyzed by AKEL during initial processing
642 +* Highlighting data stored as annotations with byte offsets
643 +* Client-side rendering of highlights based on verdict data
644 +* Mobile responsive (tap instead of hover)
645 +
484 484  === 8.5 Workflow & Moderation ===
485 485  
486 486  ==== FR9 — Publication Workflow ====
... ... @@ -577,8 +577,9 @@
577 577  * Simple editing (Wikipedia-style)
578 578  * Reputation system
579 579  * Basic moderation
742 +* In-article claim highlighting (FR13)
580 580  
581 -**Additional User Needs fulfilled**: UN-13
744 +**Additional User Needs fulfilled**: UN-13, UN-17
582 582  
583 583  **Phase 3 (Months 7-12): Refinement**
584 584  
... ... @@ -619,16 +619,17 @@
619 619  * UN-7: % users who access evidence details
620 620  * UN-8: % users who view multiple scenarios
621 621  * UN-15: % users who check evolution timeline
785 +* UN-17: % users who enable in-article highlighting; avg. time spent on highlighted vs. non-highlighted articles
622 622  
623 623  == 12. Requirements Traceability ==
624 624  
625 625  For full traceability matrix showing which requirements fulfill which user needs, see:
626 626  
627 -* [[User Needs>>FactHarbor.Specification.Requirements.User-Needs]] - Section 8 includes comprehensive mapping tables
791 +* [[User Needs>>FactHarbor.Specification.Requirements.User Needs.WebHome]] - Section 8 includes comprehensive mapping tables
628 628  
629 629  == 13. Related Pages ==
630 630  
631 -* **[[User Needs>>FactHarbor.Specification.Requirements.User-Needs]]** - What users need (drives these requirements)
795 +* **[[User Needs>>FactHarbor.Specification.Requirements.User Needs.WebHome]]** - What users need (drives these requirements)
632 632  * [[Architecture>>FactHarbor.Specification.Architecture.WebHome]] - How requirements are implemented
633 633  * [[Data Model>>FactHarbor.Specification.Data Model.WebHome]] - Data structures supporting requirements
634 634  * [[Workflows>>FactHarbor.Specification.Workflows.WebHome]] - User interaction workflows