Documentation8 min de lecture

Base de connaissance : wiki, validation des pages et rattachements

Le module OCA `document_page_approval` (dépôt `knowledge`, version 18.0.1.2.0, licence AGPL-3) ajoute un **circuit de validation aux pages du wiki** : toute modification de contenu peut exiger une approbation avant publication, avec un écran de **demandes de modification**. Quatorze autres modules traitent le wiki, les droits par page et les rattachements métier.

Documentation interne consultée sur un écran

Les procédures d'une PME vivent dans un dossier partagé, un intranet abandonné ou la tête de trois personnes. Les mettre dans l'ERP change une chose décisive : elles se trouvent à l'endroit où le travail se fait, et elles se rattachent à ce qu'elles décrivent.

Quinze modules communautaires fournissent ce wiki interne. Ils terminent le dépôt knowledge.

Résumé

Deux modules forment le socle : un module de gestion documentaire créant le menu de premier niveau et les groupes d'accès, et le wiki lui-même — pages, catégories, versionnement et historique.

Quatre modules traitent les droits : l'accès page par page par groupe de sécurité, son extension aux rôles utilisateur, l'accès par catégorie, et le circuit de validation des modifications.

Cinq modules traitent les rattachements : une page liée à un partenaire, à un produit, à un projet, à une tâche de projet, et des références croisées entre pages.

Un module ajoute des étiquettes aux pages, un autre un lien vers une adresse externe. Deux modules enfin traitent les pièces jointes : un aperçu sans téléchargement, et le téléchargement groupé en archive.

L'essentiel

  • Un wiki interne versionné, avec historique des pages.
  • Un circuit de validation des modifications de contenu.
  • L'accès page par page par groupe de sécurité.
  • L'accès par catégorie, pour les familles de documents.
  • Des pages rattachées aux produits, projets et tâches.
  • Des références croisées entre pages.
  • Un aperçu des pièces jointes sans téléchargement.
  • Le téléchargement groupé de pièces jointes en archive.

Ce que ces modules ajoutent à l'instance

FamilleModulesNombre
Socledocument_knowledge, document_page2
Droits et validationdocument_page_access_group, document_page_access_group_user_role, document_page_group, document_page_approval4
Rattachementsdocument_page_partner, document_page_product, document_page_project, document_page_project_task, document_page_reference5
Complémentsdocument_page_tag, document_url2
Pièces jointesattachment_preview, attachment_zipped_download2

Les menus : une application racine Connaissances avec ses Documents, ses Pages, leurs Catégories, l'Historique des pages, les Demandes de modification et un écran de parcours du contenu du wiki.

Le wiki et son versionnement

document_knowledge crée l'application Connaissances : le menu de premier niveau, la catégorie de sécurité et les groupes d'accès qui servent de base au reste.

document_page (version 18.0.2.1.3) est le wiki : rédiger, organiser en catégories et versionner des pages de documentation dans l'ERP — procédures, notices, modes opératoires. Avec son historique des pages et un écran de parcours.

Le versionnement est ce qui distingue un wiki d'un dossier partagé : savoir qui a modifié une procédure, quand, et ce qu'elle disait avant. Sur un document qualité, c'est la différence entre une procédure et une preuve.

C'est le module sur lequel reposent les manuels du système de management, traités dans système de management qualité.

Qui peut lire, qui peut modifier

  • document_page_access_group restreint l'accès page par page à des groupes de sécurité.
  • document_page_group restreint l'accès par catégorie — plus pratique quand les droits suivent des familles de documents.
  • document_page_access_group_user_role relie ces droits au mécanisme de rôles utilisateur.

Les deux premiers répondent à deux organisations : des droits par page conviennent à quelques documents sensibles, des droits par catégorie à une documentation structurée.

document_page_approval (version 18.0.1.2.0) ajoute un circuit de validation : toute modification de contenu peut exiger une approbation avant publication, avec un écran de demandes de modification.

Le circuit de validation est ce qui rend le wiki utilisable comme documentation opposable : une procédure qualité, une consigne de sécurité ou un mode opératoire réglementaire ne doivent pas changer parce que quelqu'un a cliqué sur modifier.

Rattacher la page à ce qu'elle décrit

ModuleLa page se rattache à
document_page_productUn produit — fiche technique, notice, mode d'emploi
document_page_projectUn projet — cahier des charges, comptes rendus
document_page_project_taskUne tâche de projet (version 18.0.2.0.0)
document_page_partnerUn partenaire — client, fournisseur, contact
document_page_referenceUne autre page, par référence textuelle unique

Le rattachement est tout l'intérêt de documenter dans l'ERP plutôt qu'ailleurs : la notice d'un produit s'ouvre depuis sa fiche, la consigne d'un client depuis son dossier. Une documentation qu'il faut aller chercher n'est pas lue.

document_page_reference mérite une mention : il ajoute une référence textuelle unique à chaque page et permet d'insérer des liens dynamiques entre pages. C'est ce qui évite les liens cassés quand une page est renommée.

  • document_page_tag ajoute des étiquettes aux pages.
  • document_url permet de référencer une adresse externe comme document.

Les pièces jointes

attachment_preview ajoute un aperçu des pièces jointes dans l'interface, sans téléchargement, en s'appuyant sur une bibliothèque de visualisation embarquée.

attachment_zipped_download permet de télécharger plusieurs pièces jointes en une archive, au lieu d'une par une.

L'aperçu sans téléchargement change l'usage d'un ERP documentaire : vérifier qu'une facture scannée est la bonne ne doit pas demander de télécharger un fichier, de l'ouvrir, puis de le supprimer de son dossier de téléchargements.

Le téléchargement groupé répond au cas du dossier à transmettre : un contrôle fiscal, un audit, une demande client sur un historique.

Limites connues

  • Les droits par page et par catégorie se cumulent : installer les deux demande de vérifier leur interaction.
  • document_page_access_group_user_role dépend du module de rôles utilisateur (base_user_role), une brique du dépôt des outils serveur.
  • Le circuit de validation s'applique au contenu, non à la création d'une page : une page nouvelle peut paraître sans validation.
  • Le versionnement fait grossir la base : chaque modification est une version conservée. À croiser avec les règles de purge.
  • Les pages rattachées à un produit ou un projet héritent de leurs droits d'accès : une page attachée à un projet public devient visible de qui voit le projet.
  • attachment_preview dépend d'une bibliothèque de visualisation embarquée : tous les formats ne sont pas couverts.
  • Le téléchargement groupé charge les pièces en mémoire : à éprouver sur un gros volume.
  • Ce wiki n'est pas l'application Connaissances d'Odoo Enterprise : les écrans et les fonctionnalités diffèrent, et une migration n'est pas une simple installation.

Identité technique

Les quinze modules viennent du dépôt OCA knowledge, branche 18.0 — dont tous les modules sont désormais documentés ici —, tous en licence AGPL-3. Les dépendances : document_knowledge et document_page en interne, mail et web_editor pour le wiki, product, project et portal pour les rattachements, base_user_role pour les rôles, web pour l'aperçu.

Voir aussi système de management qualité et document_page : wiki et procédures internes.

Questions fréquentes

Odoo Community a-t-il une base de connaissance ?

Pas celle de l'édition Enterprise. document_knowledge et document_page fournissent un wiki interne versionné — pages, catégories, historique — avec son application Connaissances. Les écrans et les fonctionnalités diffèrent de l'application Enterprise : une migration n'est pas une simple installation.

Peut-on exiger une validation avant publication d'une procédure ?

Oui, avec document_page_approval : toute modification de contenu peut exiger une approbation, avec un écran de demandes de modification. C'est ce qui rend le wiki utilisable comme documentation opposable — une consigne de sécurité ne doit pas changer parce que quelqu'un a cliqué sur modifier. La validation porte sur le contenu, pas sur la création d'une page.

Peut-on restreindre l'accès à certaines pages ?

Oui, de deux façons : page par page avec document_page_access_group, ou par catégorie avec document_page_group. Les droits par page conviennent à quelques documents sensibles, les droits par catégorie à une documentation structurée. document_page_access_group_user_role les relie aux rôles utilisateur.

Peut-on attacher une notice à un produit ?

Oui : document_page_product rattache une page au produit, et trois autres modules font de même pour le projet, la tâche et le partenaire. C'est tout l'intérêt de documenter dans l'ERP — une documentation qu'il faut aller chercher n'est pas lue. Attention : la page hérite des droits d'accès de l'objet attaché.

Peut-on consulter une pièce jointe sans la télécharger ?

Oui, avec attachment_preview, qui ajoute un aperçu dans l'interface. Vérifier qu'une facture scannée est la bonne ne demande alors ni téléchargement, ni ouverture, ni nettoyage du dossier de téléchargements. Tous les formats ne sont pas couverts par la bibliothèque embarquée.

Se faire accompagner

La documentation interne échoue toujours au même endroit : elle est écrite une fois, puis elle vieillit sans que personne le sache. Le versionnement et le circuit de validation ne la maintiennent pas à jour, mais ils rendent visible le moment où elle a cessé de l'être.

Nous rattachons donc les pages à ce qu'elles décrivent — produits, projets, clients — avant de nous préoccuper du contenu, parce qu'une documentation accessible depuis l'écran de travail est la seule qui soit relue. Voir les prestations d'Atalios Consulting ou demander un rappel.

Pour aller plus loin

En résumé

Les procédures d'une PME vivent dans un dossier partagé, un intranet abandonné ou la tête de trois personnes. Les mettre dans l'ERP les place là où le travail se fait et les rattache à ce qu'elles décrivent. Quinze modules fournissent ce wiki. Parlons de vos procédures.

Documentation OCAOdoo CommunityQualité

Partager

Fiches connexes

Baies de serveurs dans une salle machine
Le module OCA `queue_job` (dépôt `queue`, version 18.0.3.4.1, licence LGPL-3) ajoute à Odoo une **file de travaux de fond** avec ses canaux, ses fonctions et ses tâches, sous le menu **File d'attente des tâches** : c'est la brique dont dépendent plus de quarante modules communautaires, et la première à surveiller en exploitation. Vingt-six autres modules traitent les composants, la configuration hors base, l'impression serveur et l'IoT.
Lire la suite
Documentation OCA, Exploitation
Câbles réseau branchés sur un commutateur
Le module OCA `endpoint` (dépôt `web-api`, version 18.0.1.1.4, licence LGPL-3) permet de **déclarer un point d'entrée HTTP depuis l'interface**, sous **Paramètres ▸ Technique ▸ Endpoints** : une adresse, une méthode, un traitement — sans écrire de module. Vingt-trois autres modules traitent le cache, les imports par sessions, les échanges de factures et l'agenda.
Lire la suite
Documentation OCA, Intégration