Réviser un document AGILE, wow

Qu'est-ce qu'un snippet?

Les snippets, c'est des fragments de document que l'on peut réutiliser ailleurs. Par exemple, la garantie peut en être un, qui contient les variables Nom_de_compagnie et parfois Nom_de_produit. Ou une procédure pour nettoyer un panneau solaire, avec une variable Produit qui change selon le manuel. On construit donc un document en insérant des snippets, puis on choisit le contenu des variables quand elle ont plusieurs possibilités (produit).

Il y a des variables qui sont là également pour l'uniformité et qui ne change que très rarement. Le nom de compagnie, par exemple. Je mets Ver-Mac dans une variable que j'appelle company_short. Si jamais notre directeur au marketing dit « Johanne je préfère toujours voir Ver-Mac inc. », hop,  je vais le changer dans cette variable. Si j'ai bien pris soin de prendre la variable chaque fois que le nom de compagnie a été rédigé dans les textes des snippets, le nom de la compagnie sera correct dans toute la documentation de Ver-Mac d'un seul coup, avec la bonne typographie. Les variables sont utilisées dans Frame et InDesign, rien de nouveau ici. Mais, maintenant Word l'a aussi, c'est chouette, elles offres listes déroulantes et sont entreposées dans Sharepoint pour servir partout.

Montage des snippets, quelques découvertes

Pendant la préparation des snippets (fragments de texte), on peut constater rapidement quelques petits points:
-Il est important de bien nommer les fragments de textes, ce sont les mots-clés pour les trouver rapidement par la suite.
-Un plan de réutilisation est nécessaire avant de commencer parce que même en connaissant bien les produit on peut faire des erreurs. Ce que j'appelle un plan de réutilisation, c'est tout ce que l'on voit en commun qui sera réutilisé. Ce plan peut prendre forme pendant ou juste après l'audit de contenu.
-Il est préférable de faire une liste de variables d'avance.
-Il faut se préparer à changer d'idée en cours de route facilement. Autrement dit, pendant que l'on monte notre structure, toujours se demander si ce serait facile de changer d'idée, à chaque étape. Penser AGILE, c'est d'être flexible.
-Il faut vraiment bien connaître son Word pour être méthodique et il faut aimer Sharepoint; ou confier la configuration à SmartDocs et utiliser leur Sharepoint dans le nuage.

Les fonctionnalités que j'ai adorées dans SmartDocs:

• Le search-replace des mots pour des variables, fantastique.
• Comme un spectacle, regarder les snippets synchroniser quand je change ou ajoute un mot. Il change tout seul dans tout mon document de 200 pages ou le snippet est utilisé. C'est le pied.

La révision

Ce qui me mène à la révision. Après avoir transformé mon bureau en machine à snippets,  le document est monté selon les exigences, il est maintenant temps de commencer la révision. Plusieurs changements au niveau de la sécurité et des opérations ont été demandés et bien sûr, pendant l'exercice de montage, des textes désuets ont été relevés.

Tel que susmentionné, j'adore la synchronisation.

Dans cette boîte de dialogue je vois les snippets à synchroniser quand je viens d'aller porter une version plus récente ailleurs dans le document. Le même snippet ailleurs dans le document ne se met pas à jour si je ne l'ai pas demandé. Je vois la page où il loge, son numéro de version et si quelqu'un l'a sorti dans Sharepoint pour le modifier (check out).

Hier, j'ai mis des légendes numérotées automatiquement dans quelques snippets. J'ai synchronisé. J'ai parcouru mon document et voilà, les bouts de textes exactement pareils ont le bon numéro de figure. C'est tout.