|
2 | 2 | "$schema": "https://json-schema.org/draft/2020-12/schema", |
3 | 3 | "$id": "https://open-problem-lab.local/schemas/evidence.schema.json", |
4 | 4 | "title": "Evidence Record", |
| 5 | + "description": "A single verified evidence record in a problem pack. Every claim that enters canonical truth requires one or more evidence records. The burden of proof sits with the submitter — reviewers need enough information to attack the claim.", |
5 | 6 | "type": "object", |
6 | 7 | "additionalProperties": false, |
7 | 8 | "required": [ |
|
19 | 20 | "properties": { |
20 | 21 | "id": { |
21 | 22 | "type": "string", |
22 | | - "pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$" |
| 23 | + "pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$", |
| 24 | + "description": "Unique identifier for this evidence record. Use kebab-case. Example: who-malaria-fact-sheet-2024" |
23 | 25 | }, |
24 | 26 | "problem_id": { |
25 | 27 | "type": "string", |
26 | | - "pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*/[a-z0-9]+(?:-[a-z0-9]+)*$" |
| 28 | + "pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*/[a-z0-9]+(?:-[a-z0-9]+)*$", |
| 29 | + "description": "The problem pack this evidence belongs to. Must match the id field in problem.json. Example: climate-health/malaria-early-warning-africa" |
27 | 30 | }, |
28 | 31 | "claim": { |
29 | 32 | "type": "string", |
30 | | - "minLength": 20 |
| 33 | + "minLength": 20, |
| 34 | + "description": "One specific, falsifiable statement this source supports. State what the source can prove and at what grain. Do not state what it cannot prove here — use the limitations field for that." |
31 | 35 | }, |
32 | 36 | "evidence_type": { |
33 | 37 | "type": "string", |
| 38 | + "description": "The type of evidence. Use the most specific type that applies.", |
34 | 39 | "enum": [ |
35 | 40 | "primary-source", |
36 | 41 | "dataset", |
|
45 | 50 | "type": "object", |
46 | 51 | "additionalProperties": false, |
47 | 52 | "required": ["title", "url"], |
| 53 | + "description": "The source document or dataset. Use the original source, not a secondary report about it.", |
48 | 54 | "properties": { |
49 | 55 | "title": { |
50 | 56 | "type": "string", |
51 | | - "minLength": 4 |
| 57 | + "minLength": 4, |
| 58 | + "description": "Full title of the source document or dataset. Do not abbreviate." |
52 | 59 | }, |
53 | 60 | "url": { |
54 | 61 | "type": "string", |
55 | | - "format": "uri" |
| 62 | + "format": "uri", |
| 63 | + "description": "Direct, stable URL to the source. Prefer DOIs, archived URLs, or official permanent pages over search results or blog posts." |
56 | 64 | } |
57 | 65 | } |
58 | 66 | }, |
59 | 67 | "source_date": { |
60 | 68 | "type": "string", |
61 | | - "format": "date" |
| 69 | + "format": "date", |
| 70 | + "description": "Publication or last-updated date of the source in ISO 8601 format (YYYY-MM-DD). If only the year is known, use YYYY-01-01 and note the uncertainty in limitations." |
62 | 71 | }, |
63 | 72 | "access_date": { |
64 | 73 | "type": "string", |
65 | | - "format": "date" |
| 74 | + "format": "date", |
| 75 | + "description": "Date you accessed the source in ISO 8601 format (YYYY-MM-DD). Required because URLs and content change." |
66 | 76 | }, |
67 | 77 | "method": { |
68 | 78 | "type": "string", |
69 | | - "minLength": 10 |
| 79 | + "minLength": 10, |
| 80 | + "description": "How you assessed what the source proves. Describe which sections you reviewed and what analytical steps you applied. A reviewer should be able to replicate your assessment." |
70 | 81 | }, |
71 | 82 | "limitations": { |
72 | 83 | "type": "array", |
73 | 84 | "items": { |
74 | 85 | "type": "string", |
75 | 86 | "minLength": 5 |
76 | 87 | }, |
77 | | - "minItems": 1 |
| 88 | + "minItems": 1, |
| 89 | + "description": "What this source cannot prove. Be specific: name the grain, geography, time period, or causal claims that exceed what the source supports. 'Results may vary' is not a limitation." |
78 | 90 | }, |
79 | 91 | "confidence": { |
80 | 92 | "type": "string", |
| 93 | + "description": "Your confidence that this evidence record accurately represents what the source proves. Not confidence that the claim itself is true in the world.", |
81 | 94 | "enum": ["high", "medium", "low", "unknown"] |
82 | 95 | } |
83 | 96 | } |
|
0 commit comments