Souvent, quand on veut se documenter sur un logiciel, on est intéressé seulement par faire une chose bien précise. Un manuel, qui s'apparente à un livre, c'est plutôt fait pour être lu du début à la fin.
C'est pour ça qu'une documentation orientée « topiques » est souvent plus simple pour l'utilisateur. Au lieu de ressembler à un livre, ça ressemble plus à une FAQ. Chaque topique peut être lu indépendamment des autres, avec si nécessaire des liens vers d'autres pages.
GNOME a migré déjà pas mal de sa documentation sous forme de topiques, en langage Mallard. Au Desktop Summit il y a eu une conférence sur le sujet, et l'auteur en a fait un résumé sur son blog.
# Documentation orientée topiques
Posté par Sébastien Wilmet (site web personnel, Mastodon) . En réponse à la dépêche Scribus : nouveau manuel libre. Évalué à 3.
Souvent, quand on veut se documenter sur un logiciel, on est intéressé seulement par faire une chose bien précise. Un manuel, qui s'apparente à un livre, c'est plutôt fait pour être lu du début à la fin.
C'est pour ça qu'une documentation orientée « topiques » est souvent plus simple pour l'utilisateur. Au lieu de ressembler à un livre, ça ressemble plus à une FAQ. Chaque topique peut être lu indépendamment des autres, avec si nécessaire des liens vers d'autres pages.
GNOME a migré déjà pas mal de sa documentation sous forme de topiques, en langage Mallard. Au Desktop Summit il y a eu une conférence sur le sujet, et l'auteur en a fait un résumé sur son blog.