---
title: "eDF Documentation Overview"
description: "Comprehensive guide for users and auditors to understand and use the eDF."
---

# Meta

## Guidelines

1. for users/developers/engineers we describe our output / outcome as product
    * it is usable
    * there are links / lists to repos
2. we have and describe a 'product-structure-tree'
3. for auditors / governance we have a list / cross reference to Jira tickets
    * R&D ?, 
    * mappen auf die projektphasen, wie erstellt ein team eine plattform? 
        * stw. mobbing, mob programming
    * mapping auf deliverables von IPCEI-CIS ???, bzw. mapping auf epics?
    * projekthistorie, projektdynamic, teilprojekt von eDF , teilprojekt-abhängigkiet zB 'Platform'
    * friendly user phase
    * forgejo community, OSS, PR handling
    * externe stakeholder, user experience, think ahead integration
    * technolgien, technologie-schwerpunkte, cutting-edge research
    * design/specification und bewertung von lösungsentürfen (zB VictoriaMetrics, GARM, terraform, argoCD, ...)
    * CI/CD, golden paths (anm.: ist in grobkonzept, deployment von apps von developern fehlt)

# Introduction
- Purpose of the eDF
- Target audience (developers, engineers, auditors)
- High-level product structure overview
- High-level architecture overview

# eDF Components Overview
- List of all major components
- Vertical and horizontal layers explained
- Component maturity/status (fully integrated, partial, experimental)

# Getting Started
- Quickstart guide for developers
- Onboarding steps for eDF engineers
- Prerequisites and environment setup

# Component Details
For each component:
- Description and purpose
- Repository link
- README summary
- Architecture diagrams (link to Miro/Lucid)
- Usage instructions
- Integration points

# Development Experience
- How to contribute
- Local development workflow
- CI/CD pipelines
- Testing and validation

# Operational Experience
- Deployment guides
- Monitoring and observability
- Troubleshooting

# Audit & Compliance
- Overview of implemented controls
- Ticket references (Jira, changelogs)
- Documentation of decisions and reviews
- Evidence of value and coverage

# FAQ & Support
- Common issues and solutions
- Contact points for help

# Appendix
- Glossary
- References to external resources
