Documentation

Définitions

La majorité des RFC utilisent les termes MUST, MUST NOT, SHOULD, MAY, etc. tels que définis dans la RFC 2119

Les mots clés “DOIT”, “NE DOIT PAS”, “OBLIGATOIRE”, “DEVRA”, “NE DEVRA PAS”, “DEVRAIT”, “NE DEVRAIT PAS”, “RECOMMANDÉ”, “PEUT”, et “OPTIONNEL” dans ce document doivent être interprétés comme décrit dans la RFC 2119.

Voir https://www.rfc-editor.org/rfc/rfc2119

Type de documents

Les documents de bases sont :

Dossier d’architecture technique (DAT)

Dossier d’installation (DIN)

Dossier d’exploitation (DEX) / Runbook

Documentation de montées de version (DMV)

Release notes

Exemple : https://www.programmevitam.fr/pages/documentation/pour_tech/

Ou encore :

Dossier de spécifications fonctionnelles (DSF) : pour définir les besoins métier

Dossier de spécifications techniques (DST) : décrit l’implémentation technique à partir des besoins

Dossier d’installation : pour décrire comment installer une solution

Guide utilisateur / admin : mode d’emploi

Runbook / DEX : procédures opérationnelles pas-à-pas pour les incidents

DAT :

https://www.syloe.com/glossaire/dat-document-architecture-technique/

https://dev.to/onepoint/le-dossier-darchitecture-technique-un-dinosaure-numerique--172p

https://dev.to/onepoint/les-peches-capitaux-du-dossier-darchitecture-technique-111p

https://www.datanaos.com/blog/securite/le-document-darchitecture-technique-dat-un-pilier-de-la-securite-du-systeme-dinformation/

https://data-protect-on.fr/DAT

Logiciel / GED

Voir :

GED / document management system (DMS)

https://linuxfr.org/news/nouveautes-d-avril-2025-de-la-communaute-scenari