Blogue

Organiser sa documentation : mais comment?

Avant de penser à la sauvegarde de son information, on peut se questionner sur quoi nous voulons “documenter” et comment le faire. Sans un minimum de planification, la gestion de son information d’entreprise peut vite devenir chaotique. Après tout, si on documente quelque chose, c’est pour pouvoir accéder à cette information le moment voulu.

Planifiez, mais pas trop!

C’est décidé, vous vous lancez! Mais par où commencer? Comme tout projet, il est important de bien déterminer les objectifs à réaliser. C’est la même chose pour la documentation. Que ce soit pour l’interne ou pour ses partenaires et ses clients, déterminez clairement quels sont les objectifs, pour qui, quoi transmettre comme information et comment la transmettre. Déterminez les objectifs dès le départ, mais faites attention, approchez la documentation comme un processus et non comme quelque chose de statique. On planifie, on développe, on recueille la rétroaction des utilisateurs, on évalue et on adapte.

La pertinence et la simplicité avant tout

La documentation, possiblement plus que bien d’autres choses, doit être très simple, en tout point. Souvent perçu comme quelque chose en surplus de son travail “réel”, il est capital de faire en sorte que tout soit simple. Simple à développer, simple à utiliser et simple à maintenir. Si c’est compliqué, on ne l’utilise pas on ne maintient pas la documentation. Elle perd donc toute pertinence et devient vite désuète. Il faut s’assurer que ça soit plus simple de l’utiliser et de la maintenir que de ne pas le faire!

Les objectifs

Définissez clairement les objectifs. Ils peuvent être de natures diverses:

  • Soutenir mes employés de production dans l’accomplissement de telle tâche;
  • Aider mes distributeurs à assembler tel produit;
  • Aider mes clients à utiliser tel produit

Pour qui?

Chaque objectif doit être pour une personne ou groupe de personnes en particulier. Il ne faut pas tenter de répondre à toutes les questions de tout le monde dans un même document. On perd ainsi le focus et l’objectif du document, les utilisateurs ne s’y retrouvent plus et n’accèdent pas facilement à ce dont ils ont besoin. Il vaut donc mieux des contenus par type d’utilisateurs que de tout mettre ensemble. Avec les bons outils de développement et de gestion de l’information, c’est plus facile à créer, à maintenir et à mettre à jour, pour chaque type d’utilisateur.

Quoi transmettre comme information

Trop de contenu, c’est comme pas assez! Ça s’applique aussi à la documentation technique. Il arrive souvent qu’on a développé du matériel sans même définir l’objectif au départ. Par exemple, comment utiliser tel outil, une procédure pour faire telle chose, la liste des distributeurs de tels équipements, etc. Même s’il est souvent plus naturel de définir le “quoi” en premier, il est primordial de rattacher ceci à un objectif. Après tout, comment vérifier si on fait bien quelque chose s’il n’y a pas d’objectif défini? Le contenu développé doit répondre exactement aux objectifs visés. Si ce n’est pas le cas, on supprime! À l’opposé, on doit avoir toute l’information nécessaire pour répondre à l’objectif.

Comment le transmettre

Pensez toujours simplicité… pour celui qui crée l’information, mais aussi pour l’utilisateur. Il est souvent tentant de prendre des raccourcis. Il est tout aussi important de s’assurer de bien choisir la meilleure façon de transmettre l’information, tant pour le créateur que pour l’utilisateur.

Assurez-vous de choisir les meilleurs outils pour créer et mettre à jour l’information facilement. Par exemple, dans un contexte de documentation interne, il peut y avoir ces 3 besoins (objectifs):

  • Prendre des notes rapidement et pouvoir les partager facilement: Evernote est l’outil idéal pour prendre des notes rapidement, sur n’importe quel appareil (PC, Mac, mobile, en ligne). Vous pouvez aussi les partager facilement avec d’autres personnes.
  • Collaborer sur des documents à plusieurs personnes en temps réel: Google Drive permet de créer des documents de type Word, Excel, Powerpoint et d’y collaborer à plusieurs, et ce, en temps réel. C’est donc un outil de collaboration très efficace pour créer des documents rapidement. Vous pouvez aussi organiser vos documents dans des dossiers et les partager à différentes personnes.
  • Diffuser des méthodes, documents plus standardisés: Confluence est un wiki d’entreprise qui permet de créer, collaborer, partager des connaissances dans les organisations, et ce, de manière structurée. L’utilisation de modèle de document, son interface web, sa facilité d’édition et de partage en font un outil très efficace.

Assurez-vous aussi de diffuser l’information dans un format et à un endroit qui sera facile à utiliser et adapter au contexte de l’utilisateur. Si votre utilisateur travaille sur un plancher de production, il n’est peut être pas judicieux de choisir un format qui utilise beaucoup de texte. L’utilisation de photo et vidéo est peut être mieux dans ce cas. Bref, il faut s’assurer que ça répond au besoin de l’utilisateur.

COUL_blanc

 

Lios Technologies se démarque par son expertise et son offre de services uniques au Québec. Elle fournit aux entreprises et organisations de toutes les tailles des solutions adaptées à leurs besoins. Novatrice, l’équipe de Lios utilise les technologies et les outils de documentation technique les plus avancés pour réaliser les projets de ses clients efficacement et au meilleur coût.

 

Être bien organisé en entreprise n’est pas un luxe, c’est un nécessité. Mettez en application les conseils de Lios pour votre documentation et si vous voulez organiser vos opérations, contactez notre équipe pour un démonstration de ce que les outils de gestion PHPReaction peuvent faire pour vous.

Les commentaires sont fermés, mais les trackbacks et les pingbacks sont ouverts.