J'ai pour projet de créer une documentation sous format pdf pour Pelican, projet que je suis depuis quelques temps, et qui fait l'objet de pas mal d'articles sur ce blog. J'annonce en ce début de soirée le début de création d'une documentation en format pdf sur Twitter.
J'aperçois une réponse de Stéphane de Zone Libre : «Seulement en pdf ?».
Et oui, pas si con la question. En fait, je me rend compte qu'un blog n'est pas le mieux pour faire un réel traitement de fond d'un projet comme Pelican. A la longue, j'ai peur que les potentiels utilisateurs du projet se perdent dans les articles pas forcément bien classés d'un blog.
Certes il y a plusieurs possibilités que l'on peut récapituler :
- Le fichier pdf
- Peut être téléchargé, lu hors ligne, voire imprimé. L'avantage est que l'on peut mettre à jour le pdf selon les versions du logiciel et que l'on ne risque pas de tomber sur un article qui n'est plus à jour.
- Une version en ligne du pdf
- Format aussi structuré que le pdf, mais consultable en ligne.
- Le blog
- On peut gérer des pages indépendantes des articles classiques sur le blog. Donc faire une page Sommaire pointant sur les différents sujets.
- Un wiki
- Format par excellence pour la documentation, une option que je prend de plus en plus en considération.
Bien évidemment, plusieurs formats peuvent coexister.
Il y en a peut être d'autres auxquels je n'ai pas pensé. Il faut prendre aussi en considération que Pelican est jeune, et pas mal de fonctionnalités se rajoutent au fil du temps.
Selon vous quel est le meilleur format, sachant qu'il doit être le plus perenne possible, facile à utiliser pour l'utilisateur ?
Jeu de briques
Snake
Pacman
Bubble