Wiki

Créez et gérez la documentation de projet directement depuis votre éditeur de code. Parcourez les pages hiérarchiques, éditez en Markdown, suivez les révisions et effectuez des recherches dans toute votre base de connaissances.

Le problème que cela résout

La documentation de projet vit dans un outil, le code dans un autre. Quand vous devez consulter des spécifications API, des décisions d'architecture ou des guides de configuration, vous basculez vers un navigateur, trouvez la page wiki, la lisez, puis revenez. Chaque changement de contexte interrompt votre flux de travail.

GitScrum Studio intègre le wiki dans un panneau de l'éditeur. Consultez la documentation tout en codant, mettez-la à jour au fil de l'implémentation, et ne quittez jamais votre environnement de développement.

Ce que vous voyez

Cliquez sur Wiki dans la section Knowledge de l'arborescence latérale. Le panneau s'ouvre avec une navigation arborescente à gauche et une zone de contenu à droite.

Arborescence des pages

Le côté gauche affiche toutes les pages wiki organisées en hiérarchie. Les pages peuvent contenir des sous-pages, créant des structures imbriquées pour une documentation organisée :

Premiers pas
  ├─ Guide d'installation
  ├─ Configuration
  └─ Déploiement
Référence API
  ├─ Authentification
  ├─ Endpoints
  └─ Codes d'erreur
Architecture
  └─ Schéma de base de données

Développez et réduisez les pages parentes pour naviguer dans l'arborescence. Cliquez sur n'importe quelle page pour charger son contenu dans le panneau de droite.

Zone de contenu

Le côté droit affiche le contenu de la page sélectionnée. En haut, vous voyez le titre de la page et un fil d'Ariane indiquant la position de la page dans la hiérarchie.

Créer des pages

Cliquez sur le bouton de création dans l'en-tête du panneau pour ouvrir le formulaire de nouvelle page :

Laissez le champ parent vide pour créer une page de premier niveau. Sélectionnez une page existante comme parent pour créer une sous-page imbriquée.

Modifier des pages

Cliquez sur le bouton de modification d'une page pour passer en mode édition. La zone de contenu se transforme en éditeur où vous pouvez modifier :

• Titre — L'en-tête de la page
• Contenu — Édition Markdown complète avec mise en forme standard

Enregistrez vos modifications ou annulez pour revenir en arrière. Les modifications sont enregistrées immédiatement sur le serveur.

Historique des révisions

Chaque modification crée une révision. Cliquez sur le bouton des révisions pour afficher l'historique des changements de la page :

Restaurer des versions précédentes

Vous pouvez restaurer n'importe quelle révision précédente. Cela crée une nouvelle révision qui rétablit le contenu à la version sélectionnée. Le contenu précédent est conservé dans l'historique — rien n'est définitivement perdu.

Supprimer des pages

Cliquez sur le bouton de suppression d'une page pour la retirer. Une boîte de dialogue de confirmation apparaît avant la suppression. La suppression d'une page parente peut affecter les sous-pages — vérifiez attentivement la hiérarchie avant de confirmer.

Recherche

Utilisez le champ de recherche en haut du panneau wiki pour filtrer les pages. La recherche s'effectue sur les titres des pages et affiche les résultats en temps réel au fur et à mesure de la saisie.

Astuces (une fois que vous êtes à l'aise)

• Vue partagée avec le code. Ouvrez le panneau wiki à côté de vos fichiers de code. Consultez la documentation API ou les guides d'architecture tout en implémentant.

• Utilisez l'imbrication pour structurer. Organisez les pages par module, fonctionnalité ou équipe. Les hiérarchies profondes sont plus faciles à parcourir que des listes plates de pages.

• Documentez en codant. Quand vous implémentez un algorithme complexe ou configurez une intégration délicate, mettez à jour le wiki immédiatement. Cela prend 30 secondes quand le contexte est frais contre 30 minutes plus tard quand vous avez oublié les détails.

• Vérifiez les révisions avant de modifier. Si un coéquipier a récemment mis à jour une page, consultez ses modifications pour éviter d'écraser son travail.

Permissions

L'extension respecte les permissions de votre compte GitScrum :

• Propriétaires d'agence et managers : Accès CRUD complet à toutes les pages wiki
• Développeurs : Peuvent créer, modifier et consulter les pages wiki des projets assignés
• Clients : Accès en lecture seule aux pages wiki (si l'accès au projet est accordé)

Comment signaler un problème ou demander une fonctionnalité

Si les pages wiki ne se chargent pas, si les modifications ne s'enregistrent pas ou si l'historique des révisions semble incomplet, ouvrez un ticket de support dans l'application web GitScrum. Accédez à Support Tickets dans la barre latérale et décrivez le problème. Incluez la version de l'extension et les détails de l'éditeur.