v0.1.0-pre.064-065
This commit is contained in:
46
docs/templates/CRATE_USAGE_TEMPLATE.md
vendored
Normal file
46
docs/templates/CRATE_USAGE_TEMPLATE.md
vendored
Normal file
@@ -0,0 +1,46 @@
|
||||
<!-- file: docs/templates/CRATE_USAGE_TEMPLATE.md -->
|
||||
<!-- version: 1 -->
|
||||
|
||||
# Modèle de guide d’utilisation de crate
|
||||
|
||||
> Documenter uniquement la surface publique réellement accessible aux consommateurs.
|
||||
|
||||
# Utilisation de `<nom-de-crate>`
|
||||
|
||||
## Objectif
|
||||
|
||||
## Prérequis
|
||||
|
||||
## Dépendance et features
|
||||
|
||||
## Configuration
|
||||
|
||||
## Vue d’ensemble de l’API publique
|
||||
|
||||
## APIs publiques significatives
|
||||
|
||||
Pour chaque API ou groupe cohérent :
|
||||
|
||||
- chemin public ;
|
||||
- rôle ;
|
||||
- paramètres ou types associés ;
|
||||
- valeur retournée ;
|
||||
- erreurs ;
|
||||
- invariants ;
|
||||
- exemple.
|
||||
|
||||
## Types publics importants
|
||||
|
||||
## Erreurs et invariants
|
||||
|
||||
## Exemples
|
||||
|
||||
## Utilisation du binaire
|
||||
|
||||
Supprimer cette section si aucun binaire public n’existe.
|
||||
|
||||
## Limites connues
|
||||
|
||||
## Références
|
||||
|
||||
Lier les tests, exemples, fixtures et matrices canoniques sans les dupliquer.
|
||||
Reference in New Issue
Block a user