• Accueil / Salesforce / Conseils de documentation…
, Conseils de documentation de la communauté d&rsquo;administrateurs Awesome<span class="wtr-time-wrap after-title"><span class="wtr-time-number">6</span> minutes de lecture</span>

Conseils de documentation de la communauté d’administrateurs Awesome6 minutes de lecture


Avouons-le, que vous soyez un nouvel administrateur ou un administrateur chevronné, la création d’une documentation solide est clé réussir! Non seulement cela aide les utilisateurs et les pairs à mieux comprendre les processus métier, mais cela VOUS aide également lorsque vous avez du mal à vous rappeler pourquoi ou comment vous avez créé quelque chose il y a des mois.

Étant donné que la plupart d’entre nous ont nos meilleurs trucs et astuces pour documenter notre propre travail, il y a quelque temps, nous avons contacté la communauté #AwesomeAdmin pour crowdsourcing quelques favoris.

De nombreux #AwesomeAdmins ont répondu à l’appel. Deux thèmes principaux que nous avons vus étaient « juste commencer » et « devenir spécifique ». Consultez les conseils ci-dessous.

Commencer

#GénialAdmin Mark Jones a reçu des conseils simples mais solides qui lui sont restés fidèles : tenez toujours la documentation à jour et « commencez à rédiger la documentation ». C’est un conseil simple, mais c’est vrai ! La partie la plus difficile de la documentation est juste de commencer et de maintenir !

Joey Eisenzimmer met en garde contre une erreur fatale que beaucoup d’entre nous commettent : essayer de revenir au document ! Épargnez-vous le chagrin et démarrez chaque nouveau projet ou processus avec un nouveau document de documentation.

Dan O’Leary partage avec nous un autre conseil simple mais crucial : ajoutez la date de création de votre documentation ainsi que le moment où elle doit être mise à jour ! Marquer la date à laquelle vous souhaitez mettre à jour le document vous tiendra responsable !

Pas sûr de savoir comment commencer? Daniel Gorton décompose tous ses meilleurs conseils pour la documentation et partage un superbe présentation de la documentation de la MVP Michelle Hansen.

Soyez précis

Au-delà du démarrage et de la maintenance, nous avons vu quelques conseils utiles de la communauté sur la façon d’être aussi précis que possible afin de bénéficier de la documentation des mois, voire des années, sur toute la ligne.

Pip Wilford partage un conseil perspicace : n’écrivez pas de documentation pour vous.

Comme je l’ai mentionné plus tôt, rédiger de la documentation est l’un des plus beaux cadeaux que vous puissiez offrir à votre futur moi. Jean Schneider partage son astuce pour comprendre exactement où les erreurs se sont produites.

Si vous passez du temps à documenter soigneusement votre travail, incluez les détails qui comptent le plus pour vous ! Michelle Hansen partage les choses qu’elle inclut souvent dans sa documentation ci-dessous.

C’était amusant d’entendre ce que la communauté avait à dire sur la documentation. Nous voulions également offrir nos propres conseils. Voici quelques conseils de nos évangélistes administratifs sur la documentation.

Conseils de l’équipe

Mike Gerholdt, directeur principal, Évangélisation administrative :

« Écrivez tout à la troisième personne. De cette façon, vous fournissez un point de vue narratif et pouvez facilement expliquer le processus, les décisions et les principales parties prenantes impliquées. Faire de la documentation à la troisième personne vous aide également à fournir un point de vue neutre. Un exemple serait : « Le champ personnalisé « couleur préférée » a été ajouté à la demande de Farhan, le Dir. du service client, afin que les agents puissent rapidement suggérer une autre couleur de produit lorsqu’ils parlent avec les clients lors d’un appel. Il a été approuvé lors de la réunion du COE d’avril 2021.

Jen Lee, administrateur évangéliste :

« Tout le monde aime construire des choses, mais personne n’aime vraiment documenter les choses. Mais si vous le faites au fur et à mesure, ce n’est pas aussi douloureux. J’ai toujours dit aux personnes travaillant dans l’organisation que les champs de description étaient là pour une raison. Utilise les. Par exemple, pour les champs personnalisés, décrivez à quoi sert le champ. Le champ est-il rempli par un système en amont et qu’est-ce que c’est ? Les données peuplent-elles un système en aval ? Et ne vous contentez pas de répéter le nom du champ – cela ne sert à rien. Pour les champs de formule ou les règles de validation, décrivez ce qu’il fait afin que la personne n’ait pas besoin d’interpréter la syntaxe. Pour les flux, décrivez d’où il est invoqué – quelle page Lightning, quel bouton, etc. – afin que cela aide l’administrateur à revenir en arrière lors du dépannage.

Je documente également pour chaque user story sur laquelle je travaille, la solution de conception et tous les composants associés que je crée ou touche au fur et à mesure que je construis. Cela est utile lorsqu’il est temps de déployer, de transférer des connaissances ou si de futures améliorations sont nécessaires – vous avez déjà identifié tous les composants susceptibles d’être impactés. Alors, s’il vous plaît, prenez le temps de documenter. C’est important pour votre avenir et pour ceux qui vous suivront. Je pense que nous avons tous été là, où nous avons dû modifier quelque chose d’existant et il n’y a pas de documentation. Nous ne savons pas pourquoi les décisions ont été prises comme elles l’ont été ou ne comprenons pas les dépendances, et nous finissons par apporter involontairement des changements qui perturbent le processus actuel.

J. Steadman, administrateur principal évangéliste :

« Assurez-vous que tous vos flux incluent la gestion des pannes. Personnalisez un e-mail pour expliquer où l’erreur s’est produite afin qu’il soit plus facile à résoudre.

Avez-vous d’autres conseils de documentation géniaux pour nous ? Assurez-vous de le partager sur les réseaux sociaux en utilisant #AwesomeAdmin.

Ressources





Source de l’article traduit automatiquement en Français

Besoin d'aide ?
Vous utilisez Pardot depuis un certain temps mais vous n'êtes pas sûr d'en
exploiter tout le potentiel

Notre analyse de votre Pardot offerte dès aujourd'hui
Merci, vous pouvez compléter notre questionnaire
Nous allons revenir vers vous rapidement !

Fermer