Modèle de documentation Salesforce à télécharger
Un modèle Markdown gratuit, sans inscription : périmètre, objets, règles, sources, tests et questions ouvertes.
Un modèle utilisable avec ou sans aprity
Téléchargez le fichier Markdown. Ouvrez-le dans votre éditeur ou copiez-le dans votre outil documentaire. Une section décrit un composant ou un processus. Le modèle ne contient aucune donnée client.
Commencez par la date, l’environnement et le périmètre. Remplacez ensuite les champs entre crochets. Si une information manque, écrivez « inconnu ». N’écrivez ni zéro ni « aucun » sans l’avoir vérifié.
Ce que vous allez renseigner
- Identité : objet ou composant, nom API, version, état d’activation, responsable.
- Comportement : déclencheur, conditions, lectures, écritures, branches, exceptions.
- Preuves : chemin du fichier, composant source, révision, passage qui justifie chaque affirmation.
- Dépendances : composants liés et systèmes externes, avec le périmètre de recherche.
- Vérification : résultat attendu, résultat observé, date d’exécution.
- Décisions : intention métier confirmée, questions ouvertes, prochaine revue.
Avant de publier
Faites relire la fiche par quelqu’un qui ne l’a pas écrite. Il doit retrouver chaque source. Gardez le résultat attendu et le résultat observé dans deux colonnes distinctes.
Retirez les secrets, les identifiants personnels et les données métier inutiles. Rangez les preuves sensibles dans un espace aux droits adaptés.
Références
Méthode rédigée par aprity. Salesforce publie aussi ses conseils de documentation, ci-dessous.
- Salesforce — Documentation strategies (en anglais)
Trois ressources pour documenter votre org
Une méthode, un modèle réutilisable et un exemple commenté. Sans inscription.
Comment documenter une org Salesforce
Une méthode pratique pour documenter une org Salesforce : objets, automatisations, dépendances, sources, et mise à jour après chaque livraison.
Modèle de documentation Salesforce à télécharger
Un modèle Markdown gratuit, sans inscription : périmètre, objets, règles, sources, tests et questions ouvertes.
Exemple de documentation Salesforce avec sa source
Une règle de validation suivie de sa formule à son explication, puis à ses cas de vérification. Exemple construit pour la démonstration, sans inscription.
Appliquez la méthode à votre org
Testez aprity sur un périmètre que votre équipe connaît bien.