Carnet Wiki

Chantier documentation « utiliser SPIP »

Version 10 — Janvier 2012 YannX

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 une initiative comme SPIP-Info, 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.

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.). 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

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

<blockquote class="spip">

[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 !

</blockquote>

[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

Un premier travail est en-cours sur SPN