feat: add UNESCO Ethical Impact Assessment (EIA) module - #14
Merged
Conversation
…ples, impact-mapping, principles-reference, crosswalk)
…, update README and mkdocs.yml nav
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR adds a self-contained UNESCO Ethical Impact Assessment (EIA) module to the documentation site, aligned with the UNESCO Recommendation on the Ethics of Artificial Intelligence (2021). It implements all three EIA parts, all six stages as GitHub Issue Forms, machine-readable templates, a regulatory crosswalk, and CI linting/link-checking jobs.
Deliverables Checklist
A. MkDocs Documentation Pages (
docs/eia/)docs/eia/index.md— Overview: definition, who it's for, when to run, why, summary table of 3 parts + 6 stages, Quick Start admonition, attributiondocs/eia/how-to-run.md— Mermaidflowchart LRof 6 stages; one## Stage Nsection per stage with purpose, participants, key activities, outputs, and links to GitHub Issue templates; "Tracking as GitHub Issues" guidancedocs/eia/scoping.md— Part 1: 6 scoping sections (system description, data sources, affected stakeholders, decision-making context, jurisdiction/regulatory context, prior assessments);TODO(source)placeholders for verbatim EIA workbook text;!!! note "Part 1 of 3"admonitiondocs/eia/principles.md— Part 2: all 10 UNESCO principles, each with=== "Safeguards"/=== "Mitigation"content tabs;TODO(source)placeholders for verbatim EIA workbook question wordingdocs/eia/impact-mapping.md— Part 3: scoring guide (Likelihood × Severity), instructions, impact tables for all 10 principles, aggregation guidance,!!! warningadmonition for critical risksdocs/eia/principles-reference.md— 4 core values with paragraph descriptions; 10-principle reference table (definition, EIA parts, regulatory instruments);!!! quoteUNESCO preambledocs/eia/crosswalk.md— Regulatory crosswalk with 5 content tabs: NIST AI RMF, EU AI Act (with FRIA Article 27 note), OECD Principles, ISO/IEC 42001, CoE HUDERIA; cross-framework summary tableB. Reusable Templates (
eia/templates/)eia/templates/eia-template.md— Fillable Markdown EIA with front matter, Parts 1–3, all 10 principles, sign-off tableeia/templates/impact-mapping.md— Standalone impact tables for all 10 principleseia/templates/eia.schema.json— JSON Schema draft-07 with all required fields (schema_version,system_name,assessment_date,status,assessors,part1_scoping,part2_principles,part3_impacts);part3_impactsitems includeprincipleenum,impact_typeenum (positive/negative),likelihood/severityintegers 1–5;statusenum (draft/in-review/complete/archived)eia/templates/eia.example.yaml— Realistic example for an LLM-based HR screening tool (ResumeRank v1.2) with 5 assessors, filled scoping section, 3 principles with safeguards/gaps/mitigations, 7 impact entries (mix of positive and negative), mitigation owners and due datesC. GitHub Issue Forms (
.github/ISSUE_TEMPLATE/)Maps EIA stages to GitHub Issue Forms — one form per stage:
eia-stage-1-scoping.yml— Labels:eia,eia-stage-1; fields: system_name, system_description, intended_use, data_sources, affected_stakeholders, decision_type (dropdown), regulatory_context, assessment_lead, target_completioneia-stage-2-team.yml— Labels:eia,eia-stage-2; fields: team_members, disciplines_represented (checkboxes: 9 disciplines), gaps_in_representationeia-stage-3-async.yml— Labels:eia,eia-stage-3; fields: assigned_to, system_ref, principles_reviewed (checkboxes for all 10), notes_per_principle, blockerseia-stage-4-workshop.yml— Labels:eia,eia-stage-4; fields: workshop_date, attendees, key_decisions, unresolved_issues, revised_impact_scoreseia-stage-5-stakeholders.yml— Labels:eia,eia-stage-5; fields: stakeholder_groups_engaged, engagement_method (dropdown: 5 methods), key_feedback, assessment_revisionseia-stage-6-signoff.yml— Labels:eia,eia-stage-6; fields: assessment_lead, final_status (dropdown: approved/approved-with-conditions/deferred/rejected), conditions, publication_url, next_review_date, lessons_learnedD. CI Updates
.github/workflows/ci.yml— Addedmarkdownlintjob (Node 20, markdownlint-cli, coversdocs/**/*.mdandeia/templates/**/*.md, ignoresdocs/literature/**,|| trueduring initial rollout) andlink-checkjob (lycheeverse/lychee-action@v2,fail: falseduring initial rollout). Existingtestjob (pytest) is unchanged..markdownlint.json— Root config:MD013(line length) off,MD033(inline HTML) off,MD041(first line heading) off,MD007indent: 2.github/workflows/deploy-docs.yml— Not modified (existing CI preserved)E. README Update
README.md— Added "UNESCO Ethical Impact Assessment" section after "Related Projects" with links to EIA module, issue templates, JSON schema, and regulatory crosswalk; attribution blockquoteF. mkdocs.yml Update
mkdocs.yml— AddedUNESCO EIAnav section (7 pages) between Governance Mapping and Literaturepymdownx.superfenceswith the Mermaid-enabledcustom_fencesblockcontent.tabs.linkto theme featureshttps://unpkg.com/mermaid@10/dist/mermaid.min.jstoextra_javascriptEIA Structure Mapping
docs/eia/scoping.md, Issue Form Stage 1docs/eia/principles.md, Issue Forms Stages 2–4docs/eia/impact-mapping.md, Issue Form Stage 4docs/eia/how-to-run.md, Issue Forms Stages 5–6eia/templates/eia.schema.jsonLinting and Link-Checking Note
Both
markdownlintandlycheeare added with soft failure (|| true/fail: false) during initial rollout to avoid blocking CI while the config is tuned and external links are verified. Setfail: true/ remove|| trueonce the baseline is clean.Attribution
The UNESCO Ethical Impact Assessment is a tool developed by UNESCO. Official resources and the EIA workbook are at https://www.unesco.org/ethics-ai/en/eia. The Recommendation on the Ethics of Artificial Intelligence (2021) is at https://unesdoc.unesco.org/ark:/48223/pf0000381137.
Specific EIA workbook question wording that could not be verified from publicly accessible sources is marked with
> **TODO(source):**placeholders indocs/eia/scoping.mdanddocs/eia/principles.md.🤖 Generated with Claude Code
https://claude.ai/code/session_01WFc4mqrrwQKn4ieExoB1rX
Generated by Claude Code