Collaborer à la documentation @ SD | 2021-09-01T16:39:00+02:00 | 2 minutes de lecture | Mise à jour le 2021-09-01T16:39:00+02:00

Pour sa documentation, la DSI a mis en place un wiki utilisant le même moteur que Wikipedia.

Qu’y trouve-t-on?

La documentation

Le wiki, partagé par les équipes développement et système de la DSI contient plusieurs milliers d’articles sur la documentation technique des applications et leurs interfaces, la documentation des projets, ou encore quelques règles méthodologiques. Il contient aussi de la documentation nous permettant de mieux comprendre le travail et les besoins de nos utilisateurs, comme par exemple la définition des termes spécifiques à leur métier.

Toute cette documentation complète celle présente dans outils plus techniques (test fonctionnels, tickets ou discussions dans GitLab par exemple).

Les FAQ de support

Le Wiki contient par ailleurs des FAQ. Certaines sont techniques et sont destinées aux informaticiens, comme par exemple la FAQ Oracle pour développeurs. D’autres sont destinées à aider les informaticiens à répondre aux problèmes rencontrés sur les applications que nous développons. Ces FAQ sont particulièrement utiles pour assurer la maintenance et le support utilisateur, notamment lors des permanences de nuits.

Pourquoi un Wiki ?

Par rapport à une documentation bureautique, le wiki présente une grande facilité de mise à jour : on peut, comme sous Wikipedia, compléter ou corriger les informations. De plus, la conservation systématique de toute version d’un document permet d’évaluer l’obsolescence des informations, de revenir facilement à une version antérieure et d’assurer la traçabilité des informations.

Les autres wikis

Pour animer les relations avec nos utilisateurs qui coproduisent les applications avec nous. Nous utilisons un autre moteur de wiki, à savoir XWiki, qui présente l’avantage de mieux gérer les droits d’accès.


Illustration : la structure de la base de donnée de Mediawiki - source Wikipedia - auteur Timo Tijhof - CC BY 4.0

© 2021 - 2022 Travailler au pôle documentaire de la DSI du Sénat - Que fait un ingénieur-développeur chez nous ?

Powered by Hugo with theme Dream.

avatar

DSI-docuTravailler au pôle documentaire de la DSI du Sénat - Que fait un ingénieur-développeur chez nous ?

DSI-docu

Ce site est réalisé par l’équipe documentaire de la DSI du Sénat. Il présente l’activité d’un ingénieur-développeur en son sein à travers la description des méthodes de travail et de quelques projets emblématiques sur lesquels il pourra travailler.

Pout tout renseignement, vous pouvez écrire à s.dubourg@senat.fr

Credits

Merci aux personnes dont les contributions nous ont été utiles pour la réalisation ce ce site.

  • L’image de fond est (c) Sénat.
  • Le modèle de page, dream, a été réalisé par 杨钺, merci à lui pour sa réactivité.
  • Le générateur de pages statiques est Hugo, logiciel libre.
  • L’hébergeur est Github.
Liens sociaux
Le contenu de ce site ne peut être ré-utilisé qu'après autorisation. Merci d'écrire à s.dubourg@senat.fr si besoin.