Présentation : Documentation et refonte du portail spip.net

Cette présentation a été faite durant la rencontre SPIP à Toulouse en mai 2017.

Elle propose de relancer le chantier de refonte de 2011 qui visait à refaire le portail spip.net et à revoir le rangement de la documentation.

Mieux et plus communiquer est un objectif que nous partageons. Il ne s’agit pas de faire du marketing (littéralement chercher à gagner des parts de marché), même si cela pourra être un « side effect » au passage. Non : il s’agit avant tout de s’adresser à et d’accueillir poliment un grand nombre de personnes différentes, venant de plusieurs horizons.
Pas juste des devs, donc.
Et pas juste les gens qui connaissent déjà.

Pour cela, refaire du site officiel un véritable portail d’accueil et de redirection semble une des tâches les plus importantes. Actuellement, il s’agit trop d’un site de documentation pour connaisseureuses.

Nous invitons à relancer le chantier de refonte 2011-2012 dont le but était d’arrêter un moment de documenter, pour ranger autrement. Faire de spip.net un site très léger (à la louche 10-30 pages) donc facile à améliorer maintenant puis au fil du temps.

Voici une feuille de route possible.

  • vider spip.net du maximum, donc facile à améliorer maintenant puis au fil du temps
  • faire un utiliser.spip.net pour la doc d’utilisation de l’interface
  • integrer.spip.net pour la doc du langage de squelettes
  • harmoniser et automatiser ce qu’on doit faire sur les sites de doc dédiés quand on change de version…

Diapositives de la présentation.

Utilisez les flèches droite et gauche pour naviguer, et la flèche du bas sur certaines diapos qui ont des sous-chapitres.

IMG/html/documentation_et_refonte_du_portail_spip_net.html
Diapos de la présentation sur la refonte de spip.net

Vidéo de la présentation

Il s’agit d’une première version « brute de pomme ». La version finale comprenant la capture du vidéoprojecteur sera publiée plus tard.

Cette vidéo est également consultable sur medias.spip.net

Présentation : refonte de spip.net et rangement de la documentation
Vidéo de la présentation a été faite durant la rencontre SPIP à Toulouse en mai 2017.

Discussion

2 discussions

  • 1

    Le site https://info.spip.net/ est il un prototype du futur site spip.net imaginé ou peut-il le devenir ?

    • C’est le prototype de l’anti-thèse de ce qu’on aurait en tête. :p

      J’exagère mais non. C’est pas le modèle à retenir.

    Répondre à ce message

  • 1

    Décentraliser la création de la doc avec la création d’un plugin communautaire :

    Au delà de l’idée de spliter spip.net en 3 parties, pourquoi ne pas créer un plugin permettant de mutualiser une FAQ centrale à partir des articles d’aide utilisé par chaque administrateur de site ?

    Le plugin Aide à la redaction pourrait servir de point de départ.

    Ce plugin serait relié à un site central permettant de récupérer l’ensemble des contributions des administrateur. Il permettrait :
    -  Aux administrateurs d’un site de venir puiser dans les articles composant la FAQ centrale afin de répondre aux problématiques rencontrées par ses utilisateurs.
    -  Aux administrateurs de chaque site de proposer des nouvelles réponses aux problématiques rencontrés par les utilisateurs de leurs sites.

    Exemple :
    En tant qu’intégrateur, je consacre souvent une rubrique des sites réalisés à la doc. ( par exemple, ici ) certains articles se retrouvent sur plusieurs sites et j’aimerai les synchroniser entre-eux lorsque je les améliore. ( par exemple, cette notice d’aide à l’utilisation de formidable se retrouve ici ).

    Les articles composant la FAQ pourraient avoir plusieurs statuts :

    • Mutualisation descendante : l’article est publié sur le site, il se synchronise à chaque mise à jour sur le site central
    • Proposé à la Mutualisation : l’article est publié sur le site. Il va être pris en compte pour une modification du site global
    • Article spécifique au site : article non mutualisé

    par ailleurs, les articles pourraient être associé à deux autres types de statut :

    • Un premier type de statut nommé « plugin nécessaire à cette doc » permettant d’afficher certains articles sur une partie spécifique du site central.
    • Un second type de statut nommé « version de Spip » pourrait limiter la doc à une ou plusieurs version de spip

    Enfin, il serait peut-être opportun de créer des noisettes relatives aux plugins et aux versions de Spip pour faire apparaître certains paragraphes. par exemple :

    <spipsup3.0>
    L'ensemble des documents hébergés sur votre site sont visibles et modifiables dans la médiathèque. Pour y accéder, RDV dans {{Edition > Document}}
    </spipsup3.0>

    Dynamique communautaire

    Ce type de plugin permettrait d’impulser une dynamique visant à la production communautaire d’une doc de spip. L’équipe d’admin du site central n’aurait plus qu’à valider et structurer un contenu arrivant directement sur le site d’aide et basé sur des problématiques concrètes.

    Les contributeurs réguliers seraient contactés pour devenir à leur tour administrateur du site.

    Z’en pensez quoi ?

    • Tu as l’air d’y avoir bien réfléchi en tout cas ! J’espère que tu pourras participer au projet :)

    Répondre à ce message

Ajouter un commentaire

Avant de faire part d’un problème sur un plugin X, merci de lire ce qui suit :

  • Désactiver tous les plugins que vous ne voulez pas tester afin de vous assurer que le bug vient bien du plugin X. Cela vous évitera d’écrire sur le forum d’une contribution qui n’est finalement pas en cause.
  • Cherchez et notez les numéros de version de tout ce qui est en place au moment du test :
    • version de SPIP, en bas de la partie privée
    • version du plugin testé et des éventuels plugins nécessités
    • version de PHP (exec=info en partie privée)
    • version de MySQL / SQLite
  • Si votre problème concerne la partie publique de votre site, donnez une URL où le bug est visible, pour que les gens puissent voir par eux-mêmes.
  • En cas de page blanche, merci d’activer l’affichage des erreurs, et d’indiquer ensuite l’erreur qui apparaît.

Merci d’avance pour les personnes qui vous aideront !

Par ailleurs, n’oubliez pas que les contributeurs et contributrices ont une vie en dehors de SPIP.

Qui êtes-vous ?
[Se connecter]

Pour afficher votre trombine avec votre message, enregistrez-la d’abord sur gravatar.com (gratuit et indolore) et n’oubliez pas d’indiquer votre adresse e-mail ici.

Ajoutez votre commentaire ici

Ce champ accepte les raccourcis SPIP {{gras}} {italique} -*liste [texte->url] <quote> <code> et le code HTML <q> <del> <ins>. Pour créer des paragraphes, laissez simplement des lignes vides.

Ajouter un document

Suivre les commentaires : RSS 2.0 | Atom