Voici une proposition de README.md en anglais, à la fois claire, professionnelle et accueillante :
📨 Communication Channel Documentation
Welcome to the Communication Channel Documentation repository! This space gathers all technical and functional documentation related to the Communication Channel — a powerful tool designed to deliver large-scale, secure communications across multiple channels (email, SMS, eBox, postal mail, and more).
🧭 This repository is documentation-only — it does not contain any source code at this stage. Future releases may include configuration examples, API references, and integration guides.
📖 About Communication Channel
Communication Channel is an internal platform developed by the FPS Health, Food Chain Safety and Environment (SPF Santé Publique), Belgium. It enables public services to send messages efficiently and securely to citizens, professionals, and organizations through one unified system.
Main objectives:
- Centralize and standardize communication workflows
- Ensure GDPR compliance and traceability
- Allow rapid, large-scale messaging during crises or public information campaigns
- Support multiple channels (email, SMS, eBox Citizen/Enterprise, postal mail, etc.)
📚 Repository Contents
This repository contains documentation for:
- General Doc – general
- API Documentation – XSD (see below)
- Doc for each Channel – High-level design and components (see below)
- How to publish a soap message – general
- Futur REST API WIP – rest-document rest-message
📚 List of Channels
- Doc – XSD
- ebox-citizen
- ebox-enterprise
- ehbox
- paper-mail
- govapp
- rs-ebox-api-client
- sftp
- sms
- virtual-printer
- XSD – XSD
- ebox-citizen
- ebox-enterprise
- ehbox
- paper-mail
- govapp
- rs-ebox-api-client
- sftp
- sms
- virtual-printer
🛠️ Status
This repository is currently in documentation phase. The underlying codebase and API services are maintained internally by the FPS Health IT Department.
🤝 Contact
For any questions, suggestions, or contributions related to this documentation, please contact: 📧 sebastien.kondov@health.fgov.be
🧩 License & Usage
This documentation is provided for internal use within the Belgian Federal Public Service (FPS Health). Unauthorized redistribution or external use without consent is not permitted.