Introduction aux documents

Cet article va vous présenter les différentes possibilités de documentation dans l’outil Tuleap.

Bien que le gestionnaire de documents de Tuleap ne puisse être comparé à des systèmes de gestion documentaire dédiés, il est néanmoins très pratique pour publier des documents essentiels pour votre communauté d’utilisateurs. Il peut s’agir, par exemple, de : guides d’installation, d’administration ou d’utilisation, documentation API, foire aux questions, etc.

Les fonctionnalités du gestionnaire de documents sont les suivantes :

• Le gestionnaire de documents de Tuleap peut gérer tout type de document.

• Les documents sont stockés dans des dossiers. Vous pouvez avoir des sous-dossiers dans un dossier.

• Les documents peuvent être modifiés en ligne (voir les fichiers intégrés et l’intégration de OnlyOffice).

• Des règles de contrôle d’accès peuvent être définies pour chaque document ou dossier.

• Les documents possèdent des propriétés ainsi que des propriétés pouvant être recherchées.

Activer le service des documents

Les différents formats de documents

Un projet Tuleap vous offre la possibilité de créer, mettre à jour et partager différents types de documents et fichiers.

1.Eléments de base

• Dossier : permet de regrouper et d’organiser les documents et les informations.

• Artidoc : c’est un type de document dédié à Tuleap. Chaque section du document est un artifact. Une fois le document artidoc créé, il doit être configuré avec un Tracker. Ce tracker sera utilisé pour créer de nouvelles sections.

• Fichier téléversé : tout type de document peut être téléversé. Qu’il s’agisse d’une présentation PowerPoint, d’une simple image ou d’un document complet Office. Les fichiers sont versionnés, il est donc possible d’ajouter de nouvelles versions à un document existant.

• Embarqué : texte HTML pouvant être modifié en ligne. Les fichiers intégrés sont versionnés.

2.Fichiers Office en ligne

Les fichiers Office, tels que les documents Word (.docx), PowerPoint (.pptx) ou Excel (.xlsx), peuvent être consultés, créés et modifiés directement dans votre navigateur lorsque l’intégration Only Office est activée.

3.Autres éléments

• Lien : permet à l’utilisateur de cibler un document via une URL. Le document ne sera pas stocké localement dans le Gestionnaire de Documents.

• Vide : le document n’aura aucun type. L’utilisateur pourra modifier le type après sa création.

Gérer la documentation du projet

• Mettre à jour les propriétés : si les utilisateurs disposent des permissions suffisantes, ils pourront mettre à jour les propriétés d’un document ou d’un dossier.

• Permissions : cette action permet à l’utilisateur de gérer les permissions d’un document ou d’un dossier. Les permissions des dossiers peuvent être appliquées de manière récursive à toute leur hiérarchie.

  Il existe 3 types de permissions :

  • Lecteurs

    Ceux qui peuvent « lire » un document ou accéder au contenu d’un dossier.

    « Lire » signifie accéder au document, le voir dans l’arborescence, consulter ses propriétés et son historique.

  • Rédacteurs

    Les rédacteurs sont des lecteurs qui peuvent également modifier le document.

    « Modifier » signifie mettre à jour une nouvelle version, changer le lien ou le nom de la page wiki, éditer les propriétés, déplacer l’élément ou le supprimer.

  • Gestionnaires

    Les gestionnaires sont des rédacteurs qui peuvent également définir les permissions d’un document ou d’un dossier et accéder aux journaux.

• Notifications : cette action permet aux utilisateurs d’être notifiés lorsqu’un élément est modifié. Ainsi, ils seront alertés de la création d’un document dans un dossier, de la mise à jour d’un document, de son déplacement, etc. Il leur suffit de cocher la case dédiée.

• Logs : cette action permet de choisir quels utilisateurs peuvent voir les logs ainsi que les anciennes versions (s’il y en a) des documents.

• Tables d’approbation : permet de configurer un workflow d’approbation. Pour les documents disposant d’un tableau d’approbation, un badge coloré, en fonction du statut de révision, est affiché sur les documents contenant un tableau d’approbation.

• Copier : les documents ou dossiers peuvent être copiés ou déplacés vers un autre emplacement dans la documentation du projet.

• Télécharger au format zip : téléchargement en tant que ZIP disponible pour tous les dossiers.

  Vous pouvez télécharger des dossiers sous forme d’archive ZIP. Chaque sous-dossier, fichier et fichier intégré contenu dans ce dossier sera téléchargé dans une archive ZIP. Les fichiers intégrés sont enregistrés au format HTML. L’archive ZIP contient la dernière version des fichiers.

  Veuillez noter que, même si le fichier a l’extension .zip, les fichiers ne sont en réalité pas compressés. Le format .zip est utilisé pour créer une archive téléchargeable, mais le serveur ne compressera pas les fichiers à l’intérieur, car cela serait trop lourd à gérer pour le serveur Tuleap.

  Le téléchargement d’un dossier en tant qu’archive ZIP est soumis à des limitations de taille qui peuvent être définies par l’administrateur de votre site. Par défaut, les utilisateurs ne peuvent pas télécharger de dossiers dont la taille dépasse 2 gigaoctets (Go).

Information

Si Tuleap rencontre un problème lors du traitement d’un fichier (fichier corrompu, introuvable, illisible ou mémoire insuffisante), il ajoutera un fichier nommé TULEAP_ERRORS.txt à la racine de l’archive ZIP. Ce fichier listera tous les fichiers posant problème et qui n’ont pas pu être téléchargés. Dans ce cas, veuillez en informer l’administrateur de votre site.

Information

Pour les utilisateurs de Mac OS X, il existe une limitation particulière : si le dossier dépasse 4 gigaoctets (Go) ou contient plus de 64 000 fichiers, l’outil natif de décompression de Mac OS pourrait ne pas pouvoir ouvrir l’archive. Tuleap vous avertira si vous rencontrez ce cas.

Créer un document

Rendez-vous dans la catégorie '“Documents” du menu de votre projet puis cliquez sur “Nouveau” afin d’avoir accès aux différents catégories vues plus haut. Il ne vous reste plus qu’à choisir quel type de documents/fichiers vous souhaitez créer.

Lors de la création ou du téléchargement d’un document ou d’un fichier, Tuleap vous demandera plusieurs informations dont le titre (obligatoire), la description ainsi que les permissions accordées sur ce fichier aux utilisateurs du projet, selon leur rôle.

Gérer un document

Une fois votre document créé, vous pouvez effectuer plusieurs actions comme le verrouiller, le télécharger, activer/désactiver les notifications, demander aux autres users son approbation etc…