Carnet Documentation SPIP

Chantier documentation « utiliser SPIP »

SPIP-Contrib :: Carnet Wiki :: Carnet Documentation SPIP :: Recherche :

Chantier documentation « utiliser SPIP »

Suite à des échanges sur l’IRC le 8 décembre 2009, cette page a pour vocation de rassembler les idées en vue de la publication d’une documentation utilisateurs complète et de qualité dans la rubrique "Utiliser SPIP" de spip.net.

Objectif

Même s’il existe des initiatives comme SPIP-Info et SPN, le site SPIP.net demeure de facto comme de jure le point d’entrée privilégiée vers la spiposphère. De ce fait il est nécessaire de s’assurer que le premier contact avec SPIP puisse être satisfaisant et que la documentation qui s’y trouve soit soignée. Or, le premier contact avec un outil de publication est précisément le mode opératoire à adopter en vue d’accomplir la dite publication. Si spip.net propose une documentation riche à l’attention des concepteurs de sites, même si il existe dans ce domaine une marge d’amélioration significative, la documentation utilisateurs est quasi inexistante. Le rubrique "Utiliser SPIP" se résume en effet à une poignée d’articles très insuffisants.

L’objectif de la démarche est donc de proposer une documentation en ligne, sur le site officiel de SPIP, complète, agréable et compréhensible, pour les utilisateurs de SPIP, c’est à dire les rédacteurs et administrateurs.

[(Stanislas) De mon point de vue cet objectif est en décalage avec la ligne éditoriale de spip.net. Ce site s’est construit pour les personnes qui voulaient gérer un site par elles mêmes en dépit de leur connaissance technique limitée. Spip.net ne s’adresse pas spécifiquement aux rédacteurs car c’est une casquette du spipmestre né en 2001. Et aujourd’hui, si je ne suis qu’un simple rédacteur d’un site, ce n’est pas de spip.net dont j’attends des explications ou de la doc mais du webmestre du site sur lequel je vais contribuer. Il ne faut pas oublier également que l’organisation du site et des squelettes, et plus encore les plugins installés par le spipmestre vont influer sur l’expérience utilisateur des rédacteurs. A mon sens, l’angle sur cette question sur spip.net devrait être de fournir au spipmestre le moyen d’expliquer à ses rédacteurs comment fonctionner et lui indiquer comment il peut modifier l’espace privé pour enrichir ou faciliter le travail des rédacteurs et peut être les pièges à éviter...]

[(YannX) J’apporterai une réflexion analogue aupoint de vue de Stanislas ci-dessus : spip.net est la documentation de référence, et n’est pas prévu pour l’apprentissage ; la rédaction en doit rester synthétique et descriptive !
D’autre part, un site trop "volumineux" devient assez vite ingérable, surtout en terme de navigation pour les novices ! Il me parait préférable de créer plusieurs espaces inter-connectés par la boussole, voire aussi des liens croisés plus nombreux...
Enfin, la navigation alternative par mots-clés est très souvent oubliée, au profit du seul rangement rubrico-hiérarchique des pages : une bonne navigation transversale apporte beaucoup a la facilité de lecture, comme aussi des liens de navigation suivie (les critères "suivant" proposés par marcimat..)]

Périmètre de la documentation

Le périmètre de la documentation couvrirait donc :

-  toutes les fonctionnalités de l’espace privé accessibles aux rédacteurs ;
-  toutes les fonctionnalités de l’espace privé accessibles aux administrateurs dans leur rôle de "rédacteur en chef" d’un site SPIP (essentiellement tout ce qui n’implique pas de toucher au FTP ni aux squelettes).

Il s’agit donc pour l’essentiel de ce qui est couvert dans une publication comme "SPIP pratique" de Perline mais adapté au média web et actualisé.

Style des articles

Au delà d’un tour d’horizon de l’interface, une approche par tâche semble la plus adaptée. Pour chaque tâche, un mode opératoire pas à pas permettrait d’accompagner l’utilisateur avec des captures d’écrans des différentes étapes (basées sur le site de démo par exemple).

Un screencast pourrait être ajouté également si disponible.

Le contenu serait basé sur la dernière version stable de SPIP (2.0). Il ne semble pas intéressant de produire de la rétrodocumentation.

Commentaires

SPIP.net ne prévoit pas de forum sur les articles. Peut-être peut-on lier chaque article à un thread du forum SPIP pour permettre des échanges question/réponse sur chaque fonction, lesquels pourront permettre le cas échéant d’améliorer la documentation
Il suffit d’aller voir le forum privé, en tant que rédacteur inscrit du site.. Très intéressant d’ailleurs !

Mise en oeuvre

Une première étape pourrait être de se mettre d’accord ci-après sur un plan pour ce guide utilisateur : les principales rubriques et la liste des articles.

Il faut également définir des styles de présentation (plan type, conventions de présentation, par exemple pour les captures d’écrans.

Une fois la liste adoptée, Les volontaires pourrait alors se manifester pour rédiger tel ou tel article.

La publication pourrait commencer dès qu’un chapitre complet est prêt, sous l’autorité des admin de spip.net

[cy_altern] Pour concrétiser les choses on peut commencer par un site temporaire qui permette de publier tout ce qui semble possible sans se mettre trop de contraintes et de voir comment pourra se faire l’organisation des contenus.
voir donc http://utiliser-spip.galactron.org : inscrivez vous et proposez vos articles !

Un premier travail est en-cours sur SPN sur 4 axes, définis au vu du plan du site

[stefdn] Un recensement des ressources disséminées sur le Web serait aussi utile : non pas sur cette page mais un sorte de « bibliothèque » pour les utilisateurs.

Ressources existantes

Et aussi :

Proposition de plan de la rubrique

À construire...

Volontaires pour participer au chantier