Documentation en ligne

Ajoutez et affichez la documentation en temps réel sur les pages. Les noms alternatifs pour ce module pourraient être « Documentation contextuelle » ou « Documentation en temps réel », mais inline a un joli anneau et correspond à la façon dont la documentation est placée dans le code.

Ce module créera un type de contenu « Documentation en ligne » et ajoutera un bouton bleu rond dans le coin inférieur droit de chaque page. Ce bouton bascule un panneau contenant une liste des nœuds de documentation en ligne.

La documentation est la clé pour faciliter la maintenance ou le transfert de projet. Cependant, personne n’aime écrire de la documentation et personne n’aime lire de la documentation.

La documentation en ligne essaie de soulager la charge d’écriture de la documentation simplement en permettant à l’utilisateur d’ajouter de courts morceaux de documentation directement à la page Web où le lecteur en a besoin. Cela réduit le besoin de pages Wiki étendues et de documents Word.

Accédez à la page en question, cliquez sur le bouton « Ajouter de la documentation » et commencez à écrire des documents. Il est recommandé de garder ces documents courts et simples, vous pouvez en ajouter autant que vous le souhaitez à une page et vous pouvez même les attacher à des éléments DOM.

Laisser un commentaire

Votre adresse e-mail ne sera pas publiée.