Documentation technique site web

13 Avr 2020 | Création 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, 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…

Comme 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.
Effectivement le document peut contenir une 50e de pages pour un site vitrine et pouvant aller jusqu’a une 100e pour une application.

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.

Pour aller plus loin

Bon audit Ligthouse d'un site optimisé et performant
Oct 13 2021

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

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...
Développements sur mesure agence web OpenMyDiv
Sep 10 2021

Pourquoi avoir un site Internet est-il si important ?

Un site Internet à une importance capitale pour les entreprises (de toutes les tailles) car donne beaucoup d’avantages marketing que nous allons détailler dans cet...
Création de boutique en ligne OpenMyDiv
Déc 14 2020

5 délicieuses suggestions pour votre site de restaurant

La passion que vous avez pour votre restaurant, son succès et sa notoriété devraient se traduire facilement par la gestion de votre site web. Votre site web fournit une...
Développements d'application et de site sur mesure
Juil 17 2020

Commentaire JavaScript

Un commentaire JavaScript permet aux développeurs de ne pas faire afficher une partie de code. Ainsi, cette partie ne sera pas interprétée par le navigateur. Ils sont...
Développements d'application et de site sur mesure
Juil 17 2020

Commentaire HTML

Un commentaire en HTML s'adresse aux développeurs et n'est pas affiché par les navigateurs (n'apparaît donc pas sur la page internet). Ils sont mis directement dans le...
Optimisation site agence web OpenMyDiv
Juil 09 2020

6 choses à savoir sur 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...
Création site agence web OpenMyDiv prestataire informatique
Avr 18 2020

Comment se faire de l’argent sur internet

Étant un secteur en perpétuelle évolution, Internet nous ouvre les portes vers un nouveau mode de communication. Celui-ci nous converge vers une société de plus en plus...
Documentation utilisateur pour être sur de comprendre
Avr 13 2020

Documentation utilisateur site web

Qu'est-ce qu'une documentation utilisateur ? Une documentation utilisateur, c'est un support qui décrit l'ensemble du fonctionnement d'une solution d'un point de vu...
Interface CMS Magento
Avr 13 2020

Comparatif des 8 meilleurs sites de création de site web (CMS)

Créer un site ? Oui mais comment. Le comparatif des meilleurs logiciels de création de site Internet utilisés en 2019 (appelé CMS) : Voici un comparatif des meilleurs...
Agence Web de création de site Internet Open My Div
Jan 09 2020

Top 20 logiciels et outils Indispensables à la création d’un site internet en 2021

Les outils et logiciels de création de site web sont aujourd’hui tellement nombreux qu’il peut être difficile de choisir la solution la plus adaptée à vos besoins....