Manuel de rédaction du site

#formation #rédaction #interface #ergonomie cc @tetue (pour le sujet « interface de rédaction que les contributeurices doivent comprendre facilement sans lire un autre document »)

(et #idée_pour_SPIP pour plus tard)

Une des questions importantes notamment :

How hard is it to update the help text? As needs change over time, will adjusting the instructions be a hassle?
Can you change custom field labels used in the admin interface without affecting the machine name used in queries and front-end display?

C’est-à-dire pour un CMS donné : peut-on facilement changer le label humain des champs et ajouter ou changer l’explication de chacun des champs ?

Ceci afin d’adapter rapidement l’interface de rédaction au contexte précis du site sur lequel on est.

Voir aussi : ▻http://core.spip.org/issues/3306

J’utilise à présent ceci ▻http://contrib.spip.net/Manuel-de-redaction-du-site car j’ai compris que le manuel livré en PDF avec la livraison du site ne sert à rien pour la suite de la vie du site mais c’est décontextualisé. C’est à l’endroit où il y a une manipulation à faire qu’il faut l’info.

#documentation

Pour la documentation utilisateur j’utilise dans SPIP une possibilité qui est déjà là : les annonces générales.
On peut en faire plusieurs, par exemple pour expliquer comment insérer des documents, traiter les images, pour des formulaires spécifiques, pour les mises à jour successives… Ces annonces ont l’avantage d’être envoyées par mail, puis sont accessibles en page d’accueil de l’espace privé et modifiables par les différents acteurs du site au fur et à mesure.
#SPIP #CMS_utilisateur

Je ne sais pas si c’est pertinent ou pas (c’est un questionnement), mais il faut peut-être distinguer :
1) l’aide globale au site (rarement utile)
2) les aides globales à une page ou à une zone
3) le fait de pouvoir personnaliser les labels et explications de chaque champ de chaque formulaire du site

Ce ne sont pas forcément les mêmes besoins, ni la même technique par derrière.

À mon avis (et suivant l’article Alistapart), le mieux est d’arriver à permettre le 3.

Le 1 est un pis-aller, qui peut se faire actuellement avec le plugin Manuel ou les annonces générales.

Un entre-deux, plus facilement techniquement faisable à court terme, serait de permettre le 2. Par exemple en utilisant le Compagnon comme API, dans un plugin dédié qui proposerait de rédiger des aides en de multiples endroits (vue et édition d’un type d’objet, voire personnalisation dans une branche ou un objet précis).

Pour le 3 je me rend compte que la fonctionnalité est disponible avec les champs extra et je l’utilise souvent (d’autant plus que ces champs correspondent souvent à des besoins spécifiques au site).

Il y a une API du Compagnon ou c’est une hypothèse ?

Oui et non pour Champs Extras : disons que c’est logique puisqu’on les ajoute nous-mêmes, donc forcément on peut choisir leur label et explication. :)
Le point 3 concerne surtout le fait de pouvoir modifier ceux par défaut (de SPIP et de plugins).

Pour le compagnon, oui oui, il y a une API, pipelines, etc, pour pouvoir en ajouter.