{"id":76463,"date":"2020-04-02T13:42:40","date_gmt":"2020-04-02T11:42:40","guid":{"rendered":"https:\/\/prohoster.info\/blog\/administrirovanie\/proektirovanie-v-confluence"},"modified":"2020-04-02T13:42:40","modified_gmt":"2020-04-02T11:42:40","slug":"proektirovanie-v-confluence","status":"publish","type":"post","link":"https:\/\/prohoster.info\/fr\/blog\/administrirovanie\/proektirovanie-v-confluence","title":{"rendered":"Conception dans Confluence","gt_translate_keys":[{"key":"rendered","format":"text"}]},"content":{"rendered":"

Bonjour \u00e0 tous ! <\/p>\n

Je m'appelle Masha, je travaille en tant qu'ing\u00e9nieure qualit\u00e9 au sein du groupe Tinkoff. Le travail en QA implique de nombreuses communications avec diff\u00e9rentes personnes provenant de diff\u00e9rentes \u00e9quipes, et j'ai \u00e9galement \u00e9t\u00e9 manager et formatrice de programmes \u00e9ducatifs, donc ma carte de communication \u00e9tait tr\u00e8s large. \u00c0 un moment donn\u00e9, j'ai explos\u00e9 : j'ai r\u00e9alis\u00e9 que je ne pouvais plus, je ne pouvais plus, je ne pouvais plus remplir d'\u00e9normes tonnes de tableaux et de documents illisibles. <\/p>\n

\"Conception
\n
\n<\/a><\/noindex>
\nChacun d'entre vous a s\u00fbrement imagin\u00e9 ce dont je parle en ce moment et a commenc\u00e9 \u00e0 transpirer \u00e0 froid : des listes de noms sans ordre alphab\u00e9tique, des tableaux de centaines de colonnes avec une mise en page compl\u00e8tement d\u00e9cal\u00e9e, des tableaux de milliers de lignes dans lesquels il faut frotter son doigt sur la molette de la souris pour voir le titre, des tonnes de pages d'instructions non num\u00e9rot\u00e9es, des centaines de mails transf\u00e9r\u00e9s les uns aux autres avec des donn\u00e9es \u00e0 analyser, syst\u00e9matiser et fourrer dans ces m\u00eames tableaux illisibles.<\/p>\n

\"Conception
\n
\nEt donc, quand j'ai un peu refroidi, j'ai d\u00e9cid\u00e9 d'\u00e9crire cet article. Je vais parler de la mani\u00e8re de g\u00e9rer correctement (et parfois m\u00eame confortablement) la documentation non produit. J'esp\u00e8re que l'article se r\u00e9pandra sur le web et que le niveau de d\u00e9sordre dans les d\u00e9partements voisins du d\u00e9veloppement diminuera un peu, rendant les gens (et moi y compris) un peu plus heureux.<\/p>\n

\"Conception
\n<\/p>\n

Outils<\/h2>\n

\nLa documentation produit est souvent stock\u00e9e \u00e0 c\u00f4t\u00e9 du code, ce qui est bien. La documentation non produit, en revanche, tra\u00eene souvent n'importe o\u00f9. Les gens essaient souvent de d\u00e9placer des informations depuis diff\u00e9rents endroits vers Confluence, et nous ne faisons pas exception. Donc, tout le r\u00e9cit qui suit en parlera.<\/p>\n

Confluence est en fait un moteur de wiki avanc\u00e9. Il permet de travailler avec des donn\u00e9es sous diff\u00e9rentes formes d'affichage : texte format\u00e9, tableaux, divers diagrammes. C'est un outil tr\u00e8s int\u00e9ressant et puissant, mais si on ne sait pas comment l'utiliser correctement, on obtient un fouillis de documents illisibles. Je vais vous apprendre \u00e0 l'utiliser !<\/p>\n

\"Conception
\n<\/p>\n

Macros<\/h2>\n

\nLa plupart des fonctionnalit\u00e9s de Confluence reposent sur les macros. Il y a beaucoup de macros, et elles peuvent \u00eatre combin\u00e9es entre elles. Certaines sont payantes et d'autres gratuites, et par la suite, il y aura diff\u00e9rents exemples de macros avec des liens vers leur documentation.<\/p>\n

L'interface de travail avec les macros est extr\u00eamement simple. Pour ajouter une macro, il suffit de cliquer sur le plus et de s\u00e9lectionner l'\u00e9l\u00e9ment souhait\u00e9 dans la liste.<\/p>\n

\"Conception
\n
\nSi le macro est autonome, c'est-\u00e0-dire qu'il ne n\u00e9cessite rien d'autre en son sein, il appara\u00eet comme un bloc.<\/p>\n

\"Conception
\n
\nSi le macro n\u00e9cessite quelque chose \u00e0 ins\u00e9rer \u00e0 l'int\u00e9rieur, il appara\u00eet comme un cadre.<\/p>\n

\"Conception
\n
\nDans ce cas, vous pouvez ins\u00e9rer autant d'autres \u00e9l\u00e9ments que vous le souhaitez dans un seul cadre, tant que votre pyramide a du sens.<\/p>\n

\"Conception
\n
\nChaque macro a un aper\u00e7u : il montre imm\u00e9diatement si vous avez correctement rempli et configur\u00e9 le macro.<\/p>\n

Mod\u00e8les<\/h2>\n

\nEn plus des macros, il existe un outil pratique de pr\u00e9-remplissage de contenu : le mod\u00e8le.
\nLes mod\u00e8les peuvent \u00eatre utilis\u00e9s lors de la cr\u00e9ation de n'importe quelle page : il suffit de cliquer sur les trois points \u00e0 c\u00f4t\u00e9 du bouton \u00ab Cr\u00e9er \u00bb et de choisir le mod\u00e8le souhait\u00e9.<\/p>\n

\"Conception
\n
\nAlors, tout le contenu pr\u00e9sent dans le mod\u00e8le sera ajout\u00e9 \u00e0 la page cr\u00e9\u00e9e.<\/p>\n

Toute personne peut cr\u00e9er des pages \u00e0 partir de mod\u00e8les, mais seuls ceux qui ont les droits peuvent cr\u00e9er ou modifier les mod\u00e8les eux-m\u00eames. Des instructions suppl\u00e9mentaires peuvent \u00eatre ajout\u00e9es au mod\u00e8le pour indiquer comment la page doit \u00eatre g\u00e9r\u00e9e.<\/p>\n

\"Conception
\n<\/p>\n

La magie des tableaux<\/h2>\n

\nEn fait, en tant que technicien, j'aime tendrement les tableaux et je peux encapsuler presque n'importe quelle information en eux (bien que ce ne soit pas toujours efficace). Les tableaux en eux-m\u00eames sont clairs, structur\u00e9s, scalables, magiques !<\/p>\n

\"Conception
\n
\nMais m\u00eame une entit\u00e9 aussi merveilleuse qu'un tableau peut \u00eatre g\u00e2ch\u00e9e. Cependant, elle peut aussi \u00eatre utilis\u00e9e avec succ\u00e8s et m\u00eame am\u00e9lior\u00e9e. C'est ce dont je vais parler ci-dessous.<\/p>\n

Filtrage (plugin payant)<\/h3>\n

\nN'importe quel tableau \u00e9norme et illisible peut devenir un peu moins gigantesque et un peu plus lisible gr\u00e2ce au filtrage. Pour cela, on peut utiliser un macro payant. \u00ab Filtre des tableaux \u00bb<\/a><\/noindex>.<\/p>\n

\u00c0 l'int\u00e9rieur de ce macro, il faut ins\u00e9rer le tableau (m\u00eame le plus laid, l'important est de le mettre dans son int\u00e9gralit\u00e9). Dans le macro, vous pouvez choisir les colonnes \u00e0 filtrer via une liste d\u00e9roulante, un filtre textuel, num\u00e9rique et un filtre par date. <\/p>\n

\"Conception
\n
\nImaginez que toutes les informations sur les candidats pour tous les postes sont enregistr\u00e9es dans une liste tabulaire. Naturellement, ils ne sont pas tri\u00e9s \u2014 les gens ne viennent pas aux entretiens par ordre alphab\u00e9tique. Et vous devez comprendre si vous avez d\u00e9j\u00e0 eu un entretien avec un candidat particulier. Il vous suffit de mettre ce chaos dans le macro de filtrage, d'ajouter un filtre textuel par nom de famille \u2014 et voil\u00e0, l'information est \u00e0 l'\u00e9cran.<\/p>\n

\"Conception
\n
\nIl convient de noter que le filtrage de grandes tables peut affecter le fonctionnement du syst\u00e8me et le temps de chargement des pages. Par cons\u00e9quent, mettre une \u00e9norme table dans un filtre est une solution temporaire. Il est pr\u00e9f\u00e9rable de mettre en place un processus qui \u00e9vite de cr\u00e9er d'\u00e9normes tables illisibles (un exemple de processus sera donn\u00e9 \u00e0 la fin de l'article).<\/p>\n

Tri (plugin payant)<\/h3>\n

\nAvec la magie d'un macro \u00ab Filtre des tableaux \u00bb<\/a><\/noindex> , il est \u00e9galement possible de d\u00e9finir un tri par d\u00e9faut pour n'importe quelle colonne et de num\u00e9roter les lignes. Ou cliquez sur n'importe quelle colonne de la table incluse dans le macro filtre, et le tri par cette colonne s'effectuera. <\/p>\n

\"Conception
\n
\nPar exemple, si vous avez la m\u00eame table avec des candidats et que vous devez estimer combien d'entretiens ont \u00e9t\u00e9 r\u00e9alis\u00e9s au cours d'un mois donn\u00e9, triez par date et r\u00e9jouissez-vous.<\/p>\n

Tableaux crois\u00e9s (plugin payant)<\/h3>\n

\nPassons maintenant \u00e0 un cas plus int\u00e9ressant. Imaginez que votre tableau est \u00e9norme et que vous devez effectuer des calculs sur celui-ci. Bien s\u00fbr, vous pouvez le copier dans Excel, faire les calculs n\u00e9cessaires et r\u00e9importer les donn\u00e9es dans Confluence. Mais vous pouvez aussi appliquer une fois le macro \u00abTableau crois\u00e9\u00bb<\/a><\/noindex> , et obtenir le m\u00eame r\u00e9sultat, mais qui est en plus actualisable.<\/p>\n

Par exemple : si vous avez un tableau contenant les donn\u00e9es de tous les employ\u00e9s \u2014 o\u00f9 ils se trouvent g\u00e9ographiquement et quels postes ils occupent \u2014 pour compter combien de personnes se trouvent dans chaque ville, vous devez s\u00e9lectionner dans le macro \u00abTableau crois\u00e9\u00bb la ligne selon laquelle les donn\u00e9es sont agr\u00e9g\u00e9es (localisation) et le type d'op\u00e9ration (somme).<\/p>\n

\"Conception
\n
\n\u00c9videmment, il est possible de regrouper selon plusieurs crit\u00e8res simultan\u00e9ment, toutes les options peuvent \u00eatre consult\u00e9es. dans la documentation<\/a><\/noindex>.<\/p>\n

Graphiques (plugin payant)<\/h3>\n

\nComme je l'ai d\u00e9j\u00e0 dit, tout le monde n'aime pas les tables autant que moi. Malheureusement, les managers, pour la plupart, ne les appr\u00e9cient pas du tout. En revanche, tout le monde aime les graphiques color\u00e9s et \u00e9clatants.
\nLes cr\u00e9ateurs de Confluence le savaient sans doute (ils ont s\u00fbrement un patron qui aime les rapports et les graphiques, quel malheur). Donc, vous pouvez utiliser le magique macro \u00abGraphique \u00e0 partir d'une table\u00bb<\/a><\/noindex>. Dans ce macro, il faut placer le tableau crois\u00e9 du point pr\u00e9c\u00e9dent, et voil\u00e0 \u2014 vos donn\u00e9es grises et ennuyeuses sont joliment visualis\u00e9es.<\/p>\n

\"Conception
\n
\n\u00c9videmment, ce macro a aussi des param\u00e8tres. Vous pouvez trouver le lien vers la documentation de n'importe quel macro en mode d'\u00e9dition de ce dernier.<\/p>\n

Simplicit\u00e9 de l'agr\u00e9gation<\/h2>\n

\nLes informations des sections pr\u00e9c\u00e9dentes n'ont s\u00fbrement pas \u00e9t\u00e9 une r\u00e9v\u00e9lation pour vous. Mais maintenant, vous savez comment utiliser les macros, et je peux passer \u00e0 une partie plus int\u00e9ressante de l'article.<\/p>\n

\"Conception
\n<\/p>\n

\u00c9tiquettes<\/h3>\n

\nC'est probl\u00e9matique lorsque les gens conservent des informations dans un seul article non structur\u00e9 ou un \u00e9norme tableau. Encore pire \u2013 lorsque certaines de ces informations sont non seulement mal pr\u00e9sent\u00e9es, mais aussi \u00e9parpill\u00e9es dans Confluence. Heureusement, il est possible de rassembler les informations \u00e9parpill\u00e9es au m\u00eame endroit. Pour cela, il faut utiliser des \u00e9tiquettes<\/a><\/noindex> (connu sous le nom de tags sur les r\u00e9seaux sociaux).<\/p>\n

\"Conception
\n
\nOn peut ajouter un nombre illimit\u00e9 d'\u00e9tiquettes \u00e0 n'importe quelle page. En cliquant sur une \u00e9tiquette, vous acc\u00e9derez \u00e0 une page d'agr\u00e9gation, o\u00f9 se trouvent des liens vers tous les documents portant cette \u00e9tiquette, ainsi qu'un ensemble d'\u00e9tiquettes associ\u00e9es. Les \u00e9tiquettes associ\u00e9es sont celles qui apparaissent souvent sur une m\u00eame page.<\/p>\n

\"Conception
\n<\/p>\n

Propri\u00e9t\u00e9s des pages<\/h3>\n

\nOn peut \u00e9galement ajouter une autre macro int\u00e9ressante pour structurer l'information \u2013 \u00ab Propri\u00e9t\u00e9s des pages \u00bb<\/a><\/noindex>. \u00c0 l'int\u00e9rieur, il faut fournir un tableau de deux colonnes, la premi\u00e8re \u00e9tant la cl\u00e9 et la seconde la valeur de la propri\u00e9t\u00e9. En outre, la macro peut \u00eatre masqu\u00e9e sur la page pour ne pas g\u00eaner la lecture du contenu, tout en permettant que la page soit toujours marqu\u00e9e avec les cl\u00e9s n\u00e9cessaires.<\/p>\n

\"Conception
\n
\nFaites attention \u00e0 l'ID \u2013 il est pratique de le d\u00e9finir pour attribuer diff\u00e9rents groupes de propri\u00e9t\u00e9s \u00e0 diff\u00e9rentes pages (ou m\u00eame \u00e0 diff\u00e9rents groupes de propri\u00e9t\u00e9s sur une seule page). <\/p>\n

Rapports<\/h3>\n

\nDes rapports peuvent \u00eatre g\u00e9n\u00e9r\u00e9s \u00e0 partir des \u00e9tiquettes. Par exemple, la macro \u00ab Rapport de contenu \u00bb<\/a><\/noindex> rassemble toutes les pages avec un ensemble sp\u00e9cifique d'\u00e9tiquettes.<\/p>\n

\"Conception
\n
\nMais un rapport plus int\u00e9ressant est la macro \u00ab Rapport sur les propri\u00e9t\u00e9s de la page \u00bb<\/a><\/noindex>. Elle collecte \u00e9galement toutes les pages avec un certain ensemble d'\u00e9tiquettes, mais ne se contente pas de les lister, elle cr\u00e9e un tableau (vous saisissez le lien avec le d\u00e9but de l'article ?), o\u00f9 les colonnes sont les cl\u00e9s des propri\u00e9t\u00e9s de la page.<\/p>\n

\"Conception
\n
\nCela cr\u00e9e un tableau r\u00e9capitulatif des informations de diff\u00e9rentes sources. Il est agr\u00e9able de noter qu'il dispose de fonctions pratiques : un design adaptatif, un tri par n'importe quelle colonne. De plus, ce tableau de rapport peut \u00eatre configur\u00e9 \u00e0 l'int\u00e9rieur de la macro. <\/p>\n

\"Conception
\n
\nLors de la configuration, il est possible de retirer certaines colonnes du rapport, de d\u00e9finir un \u00e9tat par d\u00e9faut ou un nombre d'enregistrements affich\u00e9s. Il est \u00e9galement possible de d\u00e9finir l'ID de la propri\u00e9t\u00e9 de la page pour ne voir que les informations n\u00e9cessaires.<\/p>\n

Par exemple, vous avez plusieurs pages d'employ\u00e9s, et ces pages ont un ensemble de propri\u00e9t\u00e9s concernant la personne : quel est son niveau, o\u00f9 il se trouve, quand il a rejoint l'\u00e9quipe, etc. Ces propri\u00e9t\u00e9s sont marqu\u00e9es. ID = employee_inf<\/i>. Et il y a un deuxi\u00e8me ensemble de propri\u00e9t\u00e9s sur cette m\u00eame page, qui rassemble des informations sur la personne en tant que membre de l'\u00e9quipe : quel r\u00f4le la personne joue, dans quelle \u00e9quipe elle se trouve, etc. Ces propri\u00e9t\u00e9s sont marqu\u00e9es. ID = team_inf<\/i>. Ainsi, lors de la g\u00e9n\u00e9ration de rapports, vous pouvez afficher uniquement les informations pour un seul identifiant ou pour les deux \u2014 comme cela vous arrange.<\/p>\n

La beaut\u00e9 de cette approche est que chacun peut rassembler le tableau d'informations dont il a besoin, qui ne contiendra aucune duplication et sera mis \u00e0 jour lors des mises \u00e0 jour de la page principale. Par exemple : un team lead ne se soucie pas du moment o\u00f9 ses d\u00e9veloppeurs ont \u00e9t\u00e9 embauch\u00e9s, mais il est important de savoir quel r\u00f4le chacun d'eux joue dans l'\u00e9quipe. Le team lead rassemblera un rapport sur l'\u00e9quipe. Et un comptable se moque totalement de qui joue quel r\u00f4le, mais les postes sont importants \u2014 il rassemblera un rapport bas\u00e9 sur les postes. Dans ce cas, la source d'information ne sera ni dupliqu\u00e9e ni d\u00e9plac\u00e9e.<\/p>\n

Processus final<\/h2>\n

<\/p>\n

Instruction<\/h3>\n

\nAinsi, nous pouvons structurer joliment et agr\u00e9ger efficacement les informations dans Confluence en utilisant des macros. Mais id\u00e9alement, il faut s'assurer que les nouvelles informations soient imm\u00e9diatement structur\u00e9es et int\u00e9gr\u00e9es dans tous les m\u00e9canismes d'agr\u00e9gation d\u00e9j\u00e0 utilis\u00e9s.<\/p>\n

Ici, l'association de macros et de templates viendra \u00e0 l'aide. Pour inciter les gens \u00e0 cr\u00e9er de nouvelles pages dans le format requis, vous pouvez utiliser la macro \u00ab Cr\u00e9er \u00e0 partir d'un mod\u00e8le \u00bb. Elle ajoute un bouton sur la page, qui, lorsqu'il est cliqu\u00e9, cr\u00e9e une nouvelle page \u00e0 partir du mod\u00e8le souhait\u00e9. Ainsi, vous obligez les gens \u00e0 travailler directement dans le format souhait\u00e9. <\/p>\n

\"Conception
\n
\nDans le mod\u00e8le \u00e0 partir duquel vous autorisez la cr\u00e9ation de pages, il est n\u00e9cessaire d'ajouter \u00e0 l'avance des \u00e9tiquettes, la macro \u00ab Propri\u00e9t\u00e9s de la page \u00bb et un tableau des propri\u00e9t\u00e9s dont vous avez besoin. Je vous recommande \u00e9galement d'ajouter des instructions sur les valeurs devant \u00eatre renseign\u00e9es sur la page et les valeurs des propri\u00e9t\u00e9s.<\/p>\n

\"Conception
\n
\nLe processus final appara\u00eetra ainsi :<\/p>\n

    \n
  1. Vous cr\u00e9ez un mod\u00e8le pour des informations d'un type sp\u00e9cifique.<\/li>\n
  2. Dans ce mod\u00e8le, vous ajoutez des \u00e9tiquettes et des propri\u00e9t\u00e9s de page dans la macro.<\/li>\n
  3. Dans n'importe quel endroit confortable, cr\u00e9ez une page racine avec un bouton, sur lequel un clic cr\u00e9e une page fille \u00e0 partir d'un mod\u00e8le. <\/li>\n
  4. Vous autorisez les utilisateurs potentiels \u00e0 acc\u00e9der \u00e0 la page racine, qui g\u00e9n\u00e9reront les informations n\u00e9cessaires (selon le mod\u00e8le souhait\u00e9, en cliquant sur le bouton).<\/li>\n
  5. Vous compilez un rapport bas\u00e9 sur les propri\u00e9t\u00e9s de la page via les balises que vous avez sp\u00e9cifi\u00e9es dans le mod\u00e8le.<\/li>\n
  6. Vous vous r\u00e9jouissez : vous avez toutes les informations n\u00e9cessaires dans un format pratique. <\/li>\n<\/ol>\n

    \"Conception
    \n<\/p>\n

    Les pi\u00e8ges<\/h3>\n

    \nEn tant qu'ing\u00e9nieur qualit\u00e9, je peux affirmer sans h\u00e9sitation qu'il n'y a rien de parfait dans le monde. M\u00eame les tableaux divins ne sont pas parfaits. Et dans le processus d\u00e9crit ci-dessus, il y a des \u00e9cueils.<\/p>\n