Cahier des charges Section Documentation de Drupalfr

Onglets principaux

La documentation Drupal 6 n'est plus maintenue et en cours de dépublication.

Voici un cahier des charges sur les fonctionnalités que proposerait drupalfr afin de remplir ses objectifs de documentation. Il est bien entendu ouvert à toute suggestion/amélioration de votre part...

Objectif

L'une des missions du groupe de travail autour de la traduction française de la documentation de Drupal: * Améliorer l'accès, la quantité et la qualité de la traduction de l'ensemble de la documentation de Drupal : documentation "officielle", advanced help, tutoriaux, supports de cours/formation, vidéos/podcasts, etc.

User case

  • Rechercher de la documentation
  • Soumettre de l'information : Créer un nouvel article, Choisir une politique de collaboration, Collaboration ouverte (type wiki), Collaboration modérée (type Knol), Collaboration fermée
  • Modifier un article existant
  • Suivre les version, les diffs et l'historique
  • Mettre en avant ses contributions, son expertise : Afficher son profil sur les articles soumis, Afficher les plus gros contributeurs sur la page d'accueil de la doc, Afficher les contributions les plus utiles en page d'accueil

Architecture proposée

Système de classification des contenus

Vues

  • Barre de navigation alphabétique (alpha pager), recherche thématique ou par mots-clés
  • Titre / Type, sujet ? / Etat / date de création-révision / (Contrib ?) / En ligne

Type de contenus

  • Titre
  • Etat de traduction ("en cours", "brute", "validée") [Admin ?]
  • Type de documentation : "documentation", "tips", "tutoriaux", "supports de cours", "video", "podcast", etc.
  • Tags libres ?
  • Système d'évaluation (5 stars) pour le niveau de difficulté et l'intérêt de la doc ?
  • Description
  • Corps
  • Fichiers attachés
  • Contributeur / Logo ?

Pour mémoire, spécifications reprises du cahier des charges initial

  • utiliser les path url pour avoir des url "significatives" (par exemple /documentation/pour_aller_plus_loin au lieu de /node/4681), avec une redirection permanente
  • Constituer une FAQ: FAQ/Glossaire en cours
  • migrer la documentation existante vers le wiki,
  • remplacer le lien de documentation par un lien vers le wiki,
  • Augmenter les droits dans “Documentation” pour en faire au moins quelque chose d’aussi souple qu’un wiki,
  • Désactivation des commentaires dans la doc car l’information s’y disperse. Si l’on a un vrais wiki, les corrections pourront être apporté directement sur la documentation. En cas de divergence d’opinion, une section dans le forum pourrait contenir les discutions,
  • Evidement, avoir une historique c’est fait pour les pages de type wiki,
  • Pouvoir voir les différences entre les révisions (module diff) :c’est fait,