Skip to content

Commit

Permalink
add documentation file to detail business rules (#814)
Browse files Browse the repository at this point in the history
  • Loading branch information
bellangerq authored Oct 23, 2024
1 parent 8953cd0 commit 12fe8d0
Showing 1 changed file with 46 additions and 0 deletions.
46 changes: 46 additions & 0 deletions DOCUMENTATION.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
# Documentation

Ce fichier détaille les règles métiers utilisées au sein du projet.

## Calcul du nombre de critères

Le statut final d’un critère est déterminé en calculant le résultat de l’ensemble des statuts sur chaque page et sur les éléments transverses pour ce critère.

### Critères applicables

Un critère est applicable si :

- il est conforme ou non-conforme sur au moins une page ou sur les éléments transverses.

### Critères non-applicables

Un critère est non-applicable si :

- il est non-applicable sur l’ensemble des pages et sur les éléments transverses testés.

### Critères conformes

Un critère est conforme si :

- il est conforme ou non-applicable sur l’ensemble des pages et sur les éléments transverses testés.
- il est conforme sur au moins une page ou sur les éléments transverses testés.

### Critères non-conformes

Un critère est non-conforme si :

- il est non-conforme sur au moins une page ou sur les éléments transverses.

## Taux de conformité d’un audit

Le taux de conformité d’un audit se fait selon le calcul suivant :

```
Taux de conformité = (Nombre de critères conformes / Nombre de critères applicables) * 100
```

Exemple avec 89 critères applicables et 27 critères conformes :

```
Taux de conformité = (27 / 89) * 100 = 30,34%
```

0 comments on commit 12fe8d0

Please sign in to comment.