Documentation technique site web

À quoi sert la documentation technique d’un site web ?

La documentation technique va permettre d’aborder tous les aspects techniques d’un projet web. Elle va décrire les différentes technologies utilisées, les versions, la manière de fonctionner de la solution, voir même l’interface produite. Il s’agit avant tout de bien expliquer les différents outils ou technologies utilisées. Ainsi, si la solution vient à être reprise techniquement par un intervenant différent, il a toutes les références techniques dont il a besoin pour se mettre à jour.
Elle permet aussi d’établir une ligne directrice dans la conduite des futures migrations notamment dans le cas d’utilisation d’un framework ou d’un CMS. Finalement, la documentation technique, c’est le support technique de votre équipe de développeur. Elle permet de laisser une référence détaillée de l’approche utilisée pour développer votre plateforme web. Particulièrement, sur des gros projets, elle assure une certaine pérennité par la transmission de savoir.

Que peut contenir cette documentation technique ?

En fait, c’est assez large, car cette documentation technique est assez différente selon les projets. Plus le site web va être dense, plus la documentation technique doit être étoffée et détaillée afin d’accompagner toute interrogation technique. Voici une liste exhaustive de ce que pourrait contenir la documentation technique d’un site web :

  • les mock-ups
  • des schémas de base de données
  • l’explication des librairies utilisées
  • les versions des librairies utilisées
  • la documentation API
  • le détail de l’architecture de la solution
  • etc…

Vous le voyez, il peut y avoir bon nombre de pages à rédiger, c’est pour cela que notre agence web vous propose la rédaction de documentation technique afin de vous accompagner dans ce processus.

Pourquoi mettre à jour la documentation technique de votre site web ?

Nous l’avons écrit plus haut, une documentation technique décrit des outils, framework, librairies et un système bien particulier de votre solution. Mais celle-ci est amenée à évoluer, et il faut donc logiquement modifier votre documentation en conséquence. En effet, vos futurs développeurs, qu’ils soient en internes ou externes doivent, s’ils reprennent votre solution, être au courant de l’existant. Beaucoup d’entreprises n’insistent pas assez sur le fait de développer et maintenir cette documentation technique, et c’est une erreur qui leur coûte cher. Lorsque, pour une raison quelconque, votre ou vos développeurs s’en iront, la transmission de savoir ne pourra se faire qu’à travers ce document.
Malheureusement certaines circonstances ne permettent pas au développeur de toujours assurer une formation de qualité afin de maîtriser l’outil techniquement. Le temps de cette formation est d’ailleurs souvent sous-évalué et ne permet de couvrir qu’une partie des particularités techniques. Finalement, vous l’aurez compris, la documentation technique d’un site web est un support de transmission de savoir dans le temps.

Articles similaires :

À quelle vitesse un site doit-il charger en 2020 ?

À quelle vitesse un site doit-il charger en 2020 ?

À quelle vitesse un site doit-il être chargé en 2020 ? Voici des conseils pour booster votre site internet. Le chargement rapide est primordial pour l’expérience utilisateur, mais également pour les moteurs de recherche. En fonction du contenu de votre site internet,...

6 choses à savoir sur WordPress

6 choses à savoir sur WordPress

Une infographie pour bien comprendre le rôle de Wordpress Voici une infographie concernant les avantages que représente la solution Wordpress (CMS le plus utilisé dans le monde) - Référencement naturel (SEO), tarifs, chiffres clés et solution e-commerce sont détaillés...

Partagez l'article :