Dernière mise à jour le 13 novembre 2004 par Michel Van Eeckhout

• Développer une application web incluant au moins un système de gestion de contenus (cms) et un ensemble d'outils collaboratifs (groupware), qui soit à  la fois puissant, de qualité professionnelle (leading), simple d'utilisation, stable et sécurisé.
• Trouver un juste équilibre entre ordre et chaos :
  • libre création de fonctionnalités, sans réserve et avec un développement rapide.
  • Stabilité, tests exhaustifs et documentation à  jour.
  • Garder une trace de l'activité de développement en gardant la trace de toutes les activités de développement et en les publiant systématiquement.
• Faire en sorte qu'il soit facile pour un développeur isolé d'adopter, d'améliorer ou d'ajouter des fonctionnalités
• Aider les nouveaux développeurs à  s'intégrer à  l'équipe, afin qu'ils en apprennent plus sur Tiki et contribuent plus vite.
• Fournir un réseau sympa pour les utilisateurs et développeurs de TikiWiki, favorisant l'assistance mutuelle et le support.
• Utiliser le plus possible TikiWiki pour tout ce qui concerne l'activité de notre communauté.
• Réussir à  être une communauté sympa et joyeuse où les gens peuvent facilement contribuer et enrichir Tiki
• La domination du monde.

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Dernière mise à jour le 1 août 2005 par Philippe Baret

Le travail sur la documentation de Tikiwiki a demandé un gros effort jusqu'à  la version 1.6. Cette dernière fut réellement une bonne documentation de 350 pages illustrées avec captures d'écran et tout le nécessaire. Puis, nous avons fait tiki.org et avons décider d'utilisez notre outil.

1100 pages wiki sur tiki.org
Nous avons maintenant plus de 1100 pages wiki sur http://tiki.org , des liens externes avec beaucoup d'images et divers contenus utiles. Cependant, étant donné que c'est une très large collaboration ouverte, c'est également désordonné (ou classé de trop de manières différentes), chaotique et avec un taux imprévisible d'actualisation.

La documentation structurée : un réel besoin
En dépit de l'engouement et de la joie que les programmeurs de tiki expriment à  travers la fertilité chaotique de Tikwiki.org, le besoin d'une documentation linéaire classique se fait réellement sentir pour avoir accès rapidement aux ressources. Beaucoup de contributeurs ont demandé un lieu où déposer leur production : le fait est qu'un tel travail collaboratif sur la documentation demande un point de référence pour que chacun puisse travailler de concert.

Proposition de plan
Ainsi, après des mois d'observation, d'attente et d'expectative, j'ai pris le temps de jetter les bases de ce qui pourrait être un caneva commun. J'ai préparé une structure à  partir d'une ancienne documentation, en imaginant ce qui pourrait être ajouté à  partir de tiki.org. La structure n'est pas statique, elle évoluera certainement, mais elle présente au moins une bonne base de travail : les pages crées ont justes à  être remplies.

Vue d'ensemble
Ceci est une liste de modèles subjectifs réalisés en fonction de la longueur de la documentation, du confort et de l'intelligibilité de la lecture. Les modèles prennent en compte de façon optimum les fonctionnalités Tikiwiki, avec une mise en page spécifique. Nous utilisons TikiWiki 1.9 pour écrire la documentation dorénavant, ce qui nous permet d'utiliser la fonction multi-language.

Exemples
La meilleure façon d'apprendre est de copier-coller. Les "exemples" sont des pages spécifiques conformes aux standards de la mise en page et au contenu final voulu. Nous avons besoin d'une page témoin pour chaque type de page, et jusqu'à  présent, nous en disposons de deux types : "general topic" et "feature set".

Etat de la documentation
C'est le centre de contrôle permettant de maîtriser l'évolution de la documentation ! Plus modestement, il s'agit d'une liste brute des pages issue de la documentation. Cette liste décrit l'état d'avancement ou de mise à  jour de chaque page.

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Dernière mise à jour le 19 juillet 2005 par Philippe Baret

Documentation : règles générales
Si vous voulez vous joindre à  l'effort de documentation sur TikiWiki, voici certaines règles à  suivre. Elles concernent l'intégration des pages dans une struture wiki, le contenu à  produire pour chaque fonctionnalité TikiWiki et les premiers pas du rédacteur-traducteur.

Vocabulaire de base

• Page Dans la documentation TikiWiki, le mot page correspond à  une page Wiki.
• Fonctionnalité Une fonctionnalité est une composante de TikiWiki possédant une fonction particulière, comme une gallerie d'image, une FAQ, une bannière, un forum ou encore un blogue (voir un apperçu des fonctionnalités Tikiwiki).

Intégration des pages dans une struture Wiki

• Règles
  Exemples : Documentation Templates
  Chaque page doit respecter des règles uniformes de mise en page que l'on peut apprécier dans le document Requirements par exemple.
• Etat d'avancement
  L'Etat d'avancement de la documentation est la version en cours d'élaboration et commentée de la structure Wiki. Dans le cas où vous ajoutez une page, veillez à  bien indiquer la mention A CREER pour qu'elle soit ajoutée à  la structure. Le nettoyage et le déplacement de pages sont fréquents.

Pour chaque fonctionnalité : au moins quatre pages de documentation

• Page principale
  Exemple : Blog
  C'est la page hiérachiquement la plus importante concernant la fonctionnalité. Elle en donne une définition, un aperçu de ses potentialités (qui peuvent être nombreuses, donc brièvement décrites) et pointe vers d'autres pages-ressources internes ou externes.
• Aide utilisateur
  Exemple : Blog User
  Cette page est conçue pour l'utilisateur final (y compris les administrateurs utilisant leur site). Chacune des pages utilisateur doit être organisée autour de tâches, autrement dit, ce que l'utilisateur veut accomplir (par exemple, "Créer un nouveau blogue", "Empêcher les autres utilisateurs de publier", etc.). Utilisez les copies d'écran sans hésiter.
• Aide administrateur
  Exemple : Blog Config
  Ce type de document propose tout ce que l'administrateur a besoin de savoir pour activer, configurer, entretenir ou réparer la fonctionnalité. Lorsque la nécessité se fait sentir, ce type d'aide peut décrire les conditions liées au système ou toute indication jugée nécessaire du point de vue de l'administrateur.
• Références
  Exemple : Blog Ref
  Ce type de documentation dresse une liste décrivant brièvement ce qui suit :
  • autorisations liées à  la fonctionnalité,
  • bases de données pertinentes,
  • options pour la configuration de l'administration,
  • options utilisateurs.

Premiers pas

• Devenir rédacteur
  Chaque membre de la communauté TikiWiki déclaré comme tel sur tiki.org se voit ajouter un drapeau de rédacteur sur le site documentation.
• Choisir un thème ou une fonctionnalité
  Sur cette page : Documentation Status, choisir une fonctionnalité pour laquelle contribuer.
• Trouver le contenu à  traduire
  Passez au crible http://tiki.org pour vérifier si la fonctionnalité est déjà  documentée. Si elle l'est, copiez le texte et déplacez le ici. Notez bien que le contenu ne sera pas mis en page ! Vous pourrez également voir du côté de la documentation de la version 1.6 de TikiWiki sur http://alt.thetinfoilhat.com pour peut-être trouver plus d'éléments pour la réalisation de la documentation (mais la pluspart du contenu a été reporté sur tiki.org).
• Terminer le travail
  Passez la page en revue pour qu'elle corresponde le plus fidèlement possible à  l'exemple adequat (voir Documentation Templates ). Référez vous à  la page Tiki Manual of Style pour vous assurer de la bonne présentation des titres, des liens, etc.
• Oeuvrer collectivement
  Mettez à  jour la page Documentation Status pour que les autres contributeurs sachent sur quels documents vous êtes en train de travailler (et sur ce qu'il reste à  faire).