J’ai commencé à inclure les documentations sources à quelques plugins (Yash, Typo et sysInfo pour l’instant) et je me pose la question de savoir si c’est opportun de distribuer celles-ci dans les archives des plugins, parce qu’avec quelques copies d’écran, elles commencent à peser lourd dans la balance.
Par exemple, pour sysInfo, l’archive est passée de 22 Ko à 2 Mo, ce qui fait pas mal, non ?
Solution intermédiaire : stocker les ressources images ici et s’en servir comme pseudo-CDN au sein de la doc ?
La question posée autrement est : avez-vous besoin des sources de la doc dans l’archive du plugin ?
1 De mirovinben -
Non. Pas besoin.
D’abord parce que je ne m’en sers pas, préférant venir chez toi en cas de doute sur un truc, ensuite parce que j’essaye de perdre du poids ici… et ailleurs.
2 De Franck -
À la réflexion — c’est pratique de poser des mots sur une question en suspens finalement — je pense que je vais virer la doc de l’archive distribuée.
3 De pinkilla -
Non. Tant que l’on trouve la doc, on est content. Où qu’elle soit.
4 De Philippe -
La question est peut-être bête, mais pourquoi ne pas utiliser mieux le système de documentation déjà existant pour les plugins ? Dans ce cas-là, avec seulement du html (les copies d’écran étant moins nécessaires puisqu’on est dans la page d’admin du plugin, non ?), le poids n’est pas vraiment affecté.
En l’état, l’aide des plugins est peu visible, et il faut déplier un volet riquiqui pour la lire, mais on peut y mettre beaucoup d’informations. Ne pourrait-on pas parser le html (avec une convention de mise en forme de la page d’aide) pour, par exemple, afficher un ? sous chaque rubrique dans la page d’admin du plugin, qui déplie la section d’aide correspondante ?
Enfin, en gros, hein ;)
5 De Franck -
Tu as (à peu près) fourni la réponse dans ta question, l’aide actuelle doit rester minimale vu la place fournie et le contexte d’utilisation, je la trouve personnellement très peu ergonomique. Y’a surement moyen de faire mieux aujourd’hui qu’à l’époque de son développement.
Par exemple un système de petites popups (en Js) pourrait valablement prendre le relai, éventuellement débrayable pour les cadors de l’admin.
Je note l’idée pour la page d’admin, mais ça ne vaudra que pour les plugins qui en proposent, et tous ne le font pas (à juste titre d’ailleurs).