Je me permet d'ouvrir ce post suite a un autre de mes post, ou , après une remarque concernant un soucis (pour moi) avec la documentation, m cardon m'a fait part d'une question que tranquil it se pose en interne concernant les captures d'écran dans la documentation (et la difficulté de les maintenir a jour) et me proposait de lui donner mon avis.
donc je le met ici, histoire de ne pas polluer mon post original
, et d'avoir d'autres avis?au pire ca me permettra de savoir si c'est pas juste moi qui ai du mal avec la documentation actuelle
en tout cas, WAPT est un sacré produit (et votre version de samba AD aussiconcernant les captures d'écran, a mon avis vous pourriez sans problème en supprimer une grosse partie.
les captures d'écran, c'est très bien quand la doc s'adresse a un public non "expert", mais vu le produit que vous proposez, la majorité de vos clients doivent être des administrateurs informatiques, donc des personnes habitués a lire des documentations techniques, souvent avec peu de captures.
d'autant plus que ce produit a pour but de remplacer les outils microsoft, et son installation est conseillée sur un linux, donc une grosse partie des utilisateurs doivent êtres des habitués de linux, donc ayant ingurgités des tonnes de pages "man", avec uniquement du texte
il y a beaucoup de captures dans votre documentation qui ne sont souvent qu'une illustration de quelque chose d’évident, l'explication texte est parfaitement claire, la capture n'apporte rien.
comme par exemple section "1.4.3", le texte "In the WAPT Console go to Tools ‣ Build certificate" se suffit a lui-même.
par contre pour illustrer quand il y a beaucoup de choix ça peut être bienvenu.
par exemple section "1.6.3. Build" , a mon avis la première capture est inutile, la 2éme optionnelle, la 3éme utile, la 4éme et 5éme inutiles
quelques captures c'est bien pour "aérer" le texte, mais là le soucis c'est qu'il y a tellement de captures que, quand on cherche une information précise dans la doc, c'est pénible, car il faut faire longuement défiler la page avant d'arriver a la section qui nous intéresse. surtout que (en tout cas dans mon cas), l'intercalage d'autant d'images m’empêche de repérer facilement le titre correspondant a ce que je recherche.
quand il y a 80-90% de texte, on peut faire défiler rapidement la page en ne lisant qu'a la volée les titres en gras, ce qui permet de se repérer facilement.
ce qui est surprenant, c'est de voir a quel point la différence est grande entre la doc de wapt, et l'autre que vous proposez concernant samba AD, qui elle est claire, précise et facilement utilisable
une des meilleurs documentations que j'ai pu lire (et que j'utilise souvent), c'est celle concernant les firewall watchguard, la quantité d'options et d'explication est proprement incroyable, mais ils ont réussi a garder un truc relativement clair.
https://www.watchguard.com/help/docs/he ... front.html
mais pour avoir moi-même du rédiger une doc technique il y a quelques années (et je m'étais fait étriller en beauté sur le premier jet
et d'autant plus que votre produit a déjà plusieurs années, donc la doc a du grossir au fur et a mesure.
une idée (peut-être irréalisable, c'est possible
), puissant et très utile, merci!