TEA Product Compendium - HackMD

<style> h2 {padding-top:50px;} h4 {margin:0px !important;color:darkblue;} .markdown-body table tr:nth-child(2n) {background-color:#fff} b.heading {color:#00008b47;} </style> # TEA Product Compendium :::info :information_source: **What is this document?** This is a comprehensive document that aggregates all critical information regarding the TEA platform. It is a living document, continually updated, and should be considered the central source of truth for everyone involved in the TEA product lifecycle. It should not be considered a reference only for the development team and stakeholders but also as an engagement tool for potential investors and partners, showcasing the holistic view of the TEA platform’s journey, its adherence to ethical standards, and its commitment to delivering value to users. This document builds on some previous work: :::info [:abc: The Trustworthy and Ethical Assurance (TEA) Platform](https://hackmd.io/osvTgcBpRmGjUr1Z6FWaYg?both#New-stuff-for-the-User-Guidance) [:abc: TEA-DH](https://hackmd.io/@tea-dh/Byz9pOjN3) [:abc: Co-Working](https://hackmd.io/bP3HeYUwSWCmIY2kEf9xeQ) [:abc: Phase 3 Planning](https://hackmd.io/X90WY6aLQquwUX4bwh5QMg) ::: [toc] --- ## Executive Information about the Platform  ### Summary The Trustworthy and Ethical Assurance (TEA) platform, developed by researchers at The Alan Turing Institute and University of York, is an innovative, open-source tool designed to facilitate the process of creating, managing, and sharing assurance cases for data-driven technologies, such as digital twins or AI. Our goal is to make the complex world of assurance accessible to a broad range of stakeholders and affected users, including researchers, developers, auditors, regulators, and decision-makers. With our interactive tools, comprehensive educational resources, and a supportive community infrastructure, the TEA platform can aid you in simplifying the development of arguments and evidence for goals such as safety and sustainability, accountability, fairness, and explainability. By streamlining the process of developing and communicating a structured assurance case, the TEA platform fosters a more inclusive ecosystem of trustworthy and ethical technology governance. ### Mission Statement To **democratise** the assurance process of data-driven technologies by providing an innovative, **open-source** platform that **simplifies** the creation, management, and sharing of structured assurance cases. We strive to make technology governance **accessible** to all stakeholders, facilitating the development of safe, sustainable, accountable, fair, and explainable technological solutions. ### Vision Statement We envision a future where the complexities of assurance are navigated with ease, fostering an ecosystem where ethical considerations are at the forefront of technological innovation. In this future, the TEA platform is a leading global resource for ethical technology assurance, where stakeholders, from researchers to regulators, can collaboratively contribute to the development of data-driven technologies that are inherently trustworthy and beneficial to society. ### Core Values <table> <tr> <td> <span style="color:darkblue;font-weight:700;">👐 Inclusivity</span>: We are committed to <em>making the assurance process accessible</em> to a diverse set of stakeholders, ensuring that technology governance is a collaborative and inclusive endeavor. </td> <td> <span style="color:darkblue;font-weight:700;"> 📖 Transparency</span>: We believe in open communication and clear documentation of assurance cases, <em>enabling stakeholders to understand and trust the ethical foundations</em> of technology projects. </td> </tr> <tr> <td> <span style="color:darkblue;font-weight:700;">💡 Innovation</span>: We are dedicated to continuously pushing the boundaries of what is possible in ethical assurance, <em>developing creative solutions</em> that address the evolving challenges of data-driven technologies. </td> <td> <span style="color:darkblue;font-weight:700;">🤝 Collaboration</span>: We encourage the sharing of knowledge, resources, and best practices, <em>promoting collaborative advancement</em> in the field of technology assurance by fostering a supportive community infrastructure. </td> </tr> <tr> <td> <span style="color:darkblue;font-weight:700;">🛡️ Integrity</span>: We are committed to upholding high <em>standards of honesty and accountability in all our endeavours</em>, aiming that the technologies we help assure are developed with societal benefit in mind. </td> <td> </td> </tr> </table> ## Product Architecture  ### High-level architectural overview Our technology stack ensures that the TEA platform is not only powerful and reliable but also accessible to users with different levels of technical expertise. At its core, the platform features a **web application** built with the [**React**](https://react.dev/) framework, known for its modular and interactive user interfaces. This is complemented by the [**Material UI (MUI)**](https://mui.com/) component library, which enables straightforward and consistent adoption of accessible and intuitive design elements. The web application also uses the open-source package, [**Mermaid.js**](https://mermaid.js.org/), to transform complex assurance cases into understandable flowcharts, enhancing user experience. On the backend, the TEA platform is powered by [**Django**](https://www.djangoproject.com/), a high-level Python web framework that offers robust backend capabilities, including a straightforward API for data management. Data can be stored in **[SQLite](https://www.sqlite.org/index.html) or [PostgreSQL](https://www.postgresql.org/)** databases, providing options for lightweight to more scalable storage solutions. The platform also supports easy installation and deployment through [Docker](https://www.docker.com/), making it straightforward to set up in various environments, including [Azure](https://azure.microsoft.com/en-us)~~, and offers secure login options via GitHub OAuth~~. Please visit our [documentation site](https://alan-turing-institute.github.io/AssurancePlatform/) for further details on any of the above. ==Add: security reflections== ==Add: data models== Entity relationships: ```graphviz digraph { EAPUser [label="EAPUser (User)" shape=ellipse] EAPGroup [label="EAPGroup (Group)" shape=ellipse] GitHubRepository [label=GitHubRepository shape=ellipse] AssuranceCase [label=AssuranceCase shape=rectangle] Comment [label=Comment shape=ellipse] TopLevelNormativeGoal [label="TopLevelNormativeGoal (Goal)" shape=rectangle] Context [label=Context shape=ellipse] Strategy [label=Strategy shape=ellipse] PropertyClaim [label=PropertyClaim shape=rectangle] Evidence [label=Evidence shape=cylinder] EAPUser -> EAPGroup [label=owns] EAPUser -> GitHubRepository [label=owns] EAPUser -> AssuranceCase [label=owns] EAPUser -> Comment [label=authors] EAPGroup -> AssuranceCase [label=edits dir=none] EAPGroup -> AssuranceCase [label=views dir=none] AssuranceCase -> Comment [label=has] AssuranceCase -> TopLevelNormativeGoal [label=includes] TopLevelNormativeGoal -> Context [label=contextualizes] TopLevelNormativeGoal -> Strategy [label=employs] TopLevelNormativeGoal -> PropertyClaim [label=asserts] PropertyClaim -> PropertyClaim [label=subclaims] PropertyClaim -> Evidence [label="supported by" dir=none] Strategy -> PropertyClaim [label=defines] } ``` [![image](https://hackmd.io/_uploads/B1dvRi0cT.png)](https://dbdiagram.io/d/65c12aefac844320ae7ef179) ## Product Roadmap  ==https://miro.com/app/board/uXjVN4ZBPpU=/== ## Stakeholder map  ==We need to do a stakeholder mapping exercise== ```graphviz digraph hierarchy { // increases the separation between nodes nodesep=0.5 //All nodes will this shape and colour node [color=black, fontname=Georgia, shape=box] //All the lines look like this edge [color=blue, style=solid] TEA->{ "Core Development Team" "Product Management" "Research and Academic Community" "Industry Partners and Clients" "Regulatory and Standards Bodies" "End Users" "Open Source and Developer Community" "Ethical Oversight and Advisory Boards" } // Deputy1->{Teacher1 Teacher2} // BusinessManager->ITManager // Put them on the same level // {rank=same;ITManager Teacher1 Teacher2} } ``` ## User Engagement  ### User Personas <table> <tr> <td> <h4>Stakeholder group: Core Development Team</h4> <img src="https://github.com/alan-turing-institute/turing-commons/blob/main/docs/assets/images/personas/01_Alex.png?raw=true" width="200"> <p><b class="heading">Name:</b> Alex Chen</p> <p><b class="heading">Role:</b> Lead Software Engineer</p> <p><b class="heading">Age:</b> 32</p> <p><b class="heading">Skills:</b> Expert in Python, familiar with open-source development, strong background in software architecture.</p> <p><b class="heading">Motivations:</b> Passionate about building robust, scalable software solutions.</p> <p><b class="heading">Goals:</b> To ensure the TEA platform is technically sound, maintainable, and forward-compatible.</p> <p><b class="heading">Challenges:</b> Balancing feature development with technical debt reduction.</p> </td> <td> <h4>Stakeholder group: Product Management</h4> <img src="https://github.com/alan-turing-institute/turing-commons/blob/main/docs/assets/images/personas/16_Zeenat.png?raw=true" width="200"> <p><b class="heading">Name:</b> Priya Kumar <p><b class="heading">Role:</b> Product Manager <p><b class="heading">Age:</b> 29 <p><b class="heading">Skills:</b> Strong analytical skills, experienced in Agile methodologies, excellent communicator. <p><b class="heading">Motivations:</b> Driven to meet the users' needs while aligning with the company's strategic goals. <p><b class="heading">Goals:</b> To guide the TEA platform to market success by aligning development efforts with user demands and market trends. <p><b class="heading">Challenges:</b> Prioritising features and managing stakeholder expectations. </td> </tr> <tr> <td> <h4>Stakeholder group: Research and Academic</h4> <img src="https://github.com/alan-turing-institute/turing-commons/blob/main/docs/assets/images/personas/04_Bijan.png?raw=true" width="200"> <p><b class="heading">Name:</b> Dr. Jamal Youssef <p><b class="heading">Role:</b> University Researcher <p><b class="heading">Age:</b> 40 <p><b class="heading">Skills:</b> Deep knowledge in data ethics, published author on ethical AI, experienced in qualitative research. <p><b class="heading">Motivations:</b> Contributing to the advancement of ethical considerations in technology. <p><b class="heading">Goals:</b> To use the TEA platform for research purposes and contribute to its knowledge base. <p><b class="heading">Challenges:</b> Finding tools that can adequately support complex research needs. </td> <td> <h4>Stakeholder group: Industry Partners and Clients</h4> <img src="https://github.com/alan-turing-institute/turing-commons/blob/main/docs/assets/images/personas/11_Mia.png?raw=true" width="200"> <p><b class="heading">Name:</b> Emma Clarke <p><b class="heading">Role:</b> Chief Technology Officer (CTO) at a Tech Startup <p><b class="heading">Age:</b> 35 <p><b class="heading">Skills:</b> Strategic planning, tech industry networking, business development. <p><b class="heading">Motivations:</b> Seeking innovative solutions to enhance their products' trustworthiness and ethical standing. <p><b class="heading">Goals:</b> To integrate the TEA platform into their product development lifecycle for better assurance and compliance. <p><b class="heading">Challenges:</b> Adapting existing workflows to incorporate new tools and methodologies. </td> </tr> <tr> <td> <h4>Stakeholder group: Regulatory and Standards Bodies</h4> <img src="https://github.com/alan-turing-institute/turing-commons/blob/main/docs/assets/images/personas/06_George.png?raw=true" width="200"> <p><b class="heading">Name:</b> Michael Johnson <p><b class="heading">Role:</b> Compliance Officer <p><b class="heading">Age:</b> 45 <p><b class="heading">Skills:</b> Expert in regulatory frameworks, risk assessment, and compliance auditing. <p><b class="heading">Motivations:</b> Ensuring that technologies meet the latest regulatory standards and ethical guidelines. <p><b class="heading">Goals:</b> To leverage the TEA platform for compliance checks and audits. <p><b class="heading">Challenges:</b> Keeping up with rapidly changing regulations and standards. </td> <td> <h4>Stakeholder group: End Users</h4> <img src="https://github.com/alan-turing-institute/turing-commons/blob/main/docs/assets/images/personas/17_Sara.png?raw=true" width="200"> <p><b class="heading">Name:</b> Sara Alves <p><b class="heading">Role:</b> Software Developer at a Medium-sized Enterprise <p><b class="heading">Age:</b> 28 <p><b class="heading">Skills:</b> Competent in multiple programming languages, interested in software ethics. <p><b class="heading">Motivations:</b> To develop applications that are trustworthy and meet ethical standards. <p><b class="heading">Goals:</b> To use the TEA platform to ensure her projects are ethically sound. <p><b class="heading">Challenges:</b> Learning to incorporate ethical assurance in her development process. </td> </tr> <tr> <td> <h4>Stakeholder group: Open Source and Developer Community</h4> <img src="https://github.com/alan-turing-institute/turing-commons/blob/main/docs/assets/images/personas/13_Tom.png?raw=true" width="200"> <p><b class="heading">Name:</b> Nikhil Singh <p><b class="heading">Role:</b> Open Source Contributor <p><b class="heading">Age:</b> 25 <p><b class="heading">Skills:</b> Proficient in open-source collaboration tools, active in several developer forums. <p><b class="heading">Motivations:</b> Contributing to projects that have a positive impact on society. <p><b class="heading">Goals:</b> To contribute to the TEA platform by adding new features or improving documentation. <p><b class="heading">Challenges:</b> Balancing open-source contributions with personal and professional commitments. </td> <td> <h4>Stakeholder group: Ethical Oversight and Advisory Boards</h4> <img src="https://github.com/alan-turing-institute/turing-commons/blob/main/docs/assets/images/personas/20_Taryn.png?raw=true" width="200"> <p><b class="heading">Name:</b> Dr. Elizabeth Moreno <p><b class="heading">Role:</b> Ethical Oversight Committee Chair <p><b class="heading">Age:</b> 52 <p><b class="heading">Skills:</b> Extensive experience in ethical oversight, strong leadership and decision-making abilities. <p><b class="heading">Motivations:</b> To ensure that technology development aligns with ethical principles and societal values. <p><b class="heading">Goals:</b> To use the TEA platform as a benchmark for ethical technology development. <p><b class="heading">Challenges:</b> Bridging the gap between ethical theory and practical application in technology development. </td> </tr> </table> ### Value Propositions #### <table> <tr> <td> <img src="https://github.com/alan-turing-institute/turing-commons/blob/main/docs/assets/images/personas/01_Alex.png?raw=true" width="50%"><br /> <h4>Core Development Team</h4> </td> <td> <p><b>Scenario:</b> Alex is focused on enhancing the platform's functionality, ensuring it meets the evolving needs of users. He uses the TEA platform to test new features, like improved generative AI tools for assurance cases. Alex values the platform's open-source nature, allowing him to collaborate with contributors worldwide. His primary goal is to make the platform more intuitive and feature-rich, enabling users to create and manage assurance cases more efficiently. <p><b>Value Delivered:</b> <ul>Streamlined development and testing processes</ul> <ul>Enhanced collaboration with the developer community</ul> <ul>Direct feedback implementation into the platform's evolution</ul> </td> </tr> <tr> <td> <img src="https://github.com/alan-turing-institute/turing-commons/blob/main/docs/assets/images/personas/16_Zeenat.png?raw=true" width="50%"><br /> <h4>Product Management</h4> </td> <td> <p><b>Scenario:</b> Priya oversees the strategic direction of the TEA platform. She uses the platform to gather user feedback and analyze usage patterns to prioritize feature development. Priya engages with different user groups to understand their needs, ensuring the roadmap aligns with delivering maximum value to all stakeholders. <p><b>Value Delivered:</b> <ul>Informed decision-making on feature prioritization</ul> <ul>Improved user satisfaction</ul> <ul>Alignment of product development with market needs and regulatory requirements</ul> </td> </tr> <tr> <td> <img src="https://github.com/alan-turing-institute/turing-commons/blob/main/docs/assets/images/personas/04_Bijan.png?raw=true" width="50%"><br /> <h4>Research and Academic Community</h4> </td> <td> <p><b>Scenario:</b> Dr. Youssef uses the TEA platform for his research on ethical AI development. He explores various assurance cases shared by other researchers, contributing his findings and templates. The platform aids him in teaching his students and in workshops he leads about the importance of ethical considerations in AI, using it as an educational tool to demonstrate real-world applications. <p><b>Value Delivered:</b> <ul>Access to a rich repository of assurance cases</ul> <ul>Enhanced collaboration with peers</ul> <ul>A practical tool for academic research and education</ul> </td> </tr> <tr> <td> <img src="https://github.com/alan-turing-institute/turing-commons/blob/main/docs/assets/images/personas/11_Mia.png?raw=true" width="50%"><br /> <h4>Industry Partners and Clients</h4> </td> <td> <p><b>Scenario:</b> As a CTO in a startup company, Emma uses the TEA platform to ... <p><b>Value Delivered:</b> <ul>x</ul> <ul>y</ul> <ul>z</ul> </td> </tr> <tr> <td> <img src="https://github.com/alan-turing-institute/turing-commons/blob/main/docs/assets/images/personas/06_George.png?raw=true" width="50%"><br /> <h4>Industry Partners and Clients</h4> </td> <td> <p><b>Scenario:</b> Michael is a regulator focusing on setting standards for ethical technology. He uses the TEA platform to ... <p><b>Value Delivered:</b> <ul>Efficient management of compliance reviews</ul> <ul>Direct engagement with companies</ul> <ul>The ability to influence ethical technology development practices industry-wide</ul> </td> </tr> <tr> <td> <img src="https://github.com/alan-turing-institute/turing-commons/blob/main/docs/assets/images/personas/17_Sara.png?raw=true" width="50%"><br /> <h4>End Users</h4> </td> <td> <p><b>Scenario:</b> Sara is a Software Developer at a Medium-sized Enterprise ... To use the TEA platform to ensure her projects are ethically sound, assure the privacy and security of their technologies. <p><b>Value Delivered:</b> <ul>Increased transparency into technology development practices</ul> <ul>Empowerment to influence ethical technology development</ul> <ul>A platform for internal advocacy on digital rights</ul> </td> </tr> <tr> <td> <img src="https://github.com/alan-turing-institute/turing-commons/blob/main/docs/assets/images/personas/13_Tom.png?raw=true" width="50%"><br /> <h4>Open Source and Developer Community</h4> </td> <td> <p><b>Scenario:</b> Nikhil is a an open-source contributor passionate about projects that have a positive impact on society. He uses the TEA platform to create assurance cases for open-source projects, sharing best practices with the community. <p><b>Value Delivered:</b> <ul>A collaborative environment for contributing to ethical technology</ul> <ul>Opportunities for personal development</ul> <ul>Recognition within the community</ul> </td> </tr> <tr> <td> <img src="https://github.com/alan-turing-institute/turing-commons/blob/main/docs/assets/images/personas/20_Taryn.png?raw=true" width="50%"><br /> <h4>Ethical Oversight and Advisory Boards</h4> </td> <td> <p><b>Scenario:</b> Dr. Moreno is a member of an ethical oversight board for AI technologies. She uses the TEA platform to review assurance cases from companies, providing ethical assessments and recommendations. The platform helps her to ensure that technologies are developed with consideration for ethical standards and societal impact. <p><b>Value Delivered:</b> <ul>A structured approach to ethical reviews</ul> <ul>Enhanced collaboration with technology developers</ul> <ul>A comprehensive view of technology impact assessments</ul> </td> </tr> </table> ## Quality and Compliance  ## Market Insights  ### Competitive Landscape Analysis ==https://miro.com/app/board/uXjVNxj86nQ=/== ## Go-to-Market Strategy  ### Possible taglines - From Principles to Practice: Trustworthy and Ethical Assurance Made Easy - Technology, Meet Transparency - Making AI Accountable - Your Partner in Ethical and Trustworthy Assurance - Build Trust, Drive Progress - Transforming Ethical Intentions into Measurable Impacts - Collaborative Ethics, Trusted Solutions