La Documentation Vit Séparément des Tâches et du Code

Quand la documentation vit dans des outils séparés des tâches et du code, les équipes perdent du temps à chercher, le contexte se perd et les connaissances deviennent obsolètes. NoteVault de GitScrum intègre la documentation directement avec les projets et tâches.

Le Problème de Fragmentation de la Documentation

La documentation dispersée crée une friction quotidienne:

• Fatigue de recherche — Chercher dans plusieurs endroits pour des réponses
• Information obsolète — Docs pas mis à jour quand le code change
• Perte de contexte — Pas de lien entre docs et tâches liées
• Friction d'onboarding — Nouveaux développeurs ne trouvent pas l'info
• Contenu dupliqué — Même info écrite à plusieurs endroits

Dispersion Courante de Documentation

GitScrum NoteVault: Documentation Unifiée

NoteVault amène la documentation dans votre espace projet:

Fonctionnalités

• Éditeur Markdown — Formatage riche sans complexité
• Organisation par dossiers — Structure hiérarchique par projet
• Recherche full-text — Trouvez n'importe quoi dans tous les docs
• Lien aux tâches — Connectez docs aux tâches liées
• Historique des versions — Suivez les changements dans le temps
• Édition collaborative — L'équipe peut mettre à jour ensemble

Structure de Documentation

Organisez les docs dans votre projet:

Projet: Redesign Dashboard
└── NoteVault/
    ├── Architecture/
    │   ├── Vue d'Ensemble Système
    │   ├── Design API
    │   └── Schéma Base de Données
    ├── Guides/
    │   ├── Setup Développement
    │   ├── Processus Déploiement
    │   └── Stratégie Tests
    ├── Décisions/
    │   ├── ADR-001: Choix Framework
    │   ├── ADR-002: Stratégie Auth
    │   └── ADR-003: Gestion d'État
    └── Références/
        ├── Endpoints API
        ├── Variables d'Environnement
        └── Services Tiers

Lier Documentation aux Tâches

De Tâche à Documentation

En créant ou visualisant une tâche, liez aux docs pertinents:

Tâche: Implémenter login OAuth
├── Description: Ajouter support OAuth Google
├── Docs Liés:
│   ├── ADR-002: Stratégie Auth
│   ├── Design API > Authentification
│   └── Setup Développement > Config OAuth
└── Commentaires: Voir docs liés pour détails d'implémentation

De Documentation à Tâches

Référencez les tâches dans la documentation:

## Implémentation Authentification

Pour les détails d'implémentation, voir:
- [Tâche #234: Implémenter login OAuth](/projet/taches/234)
- [Tâche #235: Ajouter gestion session](/projet/taches/235)

Statut: En Cours (Sprint 14)

Workflows de Documentation

Registres de Décision d'Architecture (ADRs)

Documentez les décisions là où elles sont actionnables:

# ADR-002: Stratégie d'Authentification

## Statut
Accepté

## Contexte
Nous devons implémenter l'authentification utilisateur pour le dashboard.

## Décision
Utiliser OAuth 2.0 avec Google comme fournisseur principal.

## Conséquences
- Implémentation plus simple (pas de gestion mots de passe)
- Dépendance à la disponibilité de Google
- SSO entreprise peut être ajouté plus tard

## Tâches Liées
- #234: Implémenter login OAuth
- #235: Ajouter gestion session
- #236: Créer flux déconnexion

Spécifications Techniques

Gardez les specs près de l'implémentation:

# Spécification API: Endpoints Utilisateur

## GET /api/users/:id

Retourne les données de profil utilisateur.

### Réponse
| Champ | Type | Description |
|-------|------|-------------|
| id | string | Identifiant unique utilisateur |
| email | string | Adresse email utilisateur |
| name | string | Nom d'affichage |

### Implémentation
- Tâche: #247
- Sprint: 14
- Statut: Terminé

Guides d'Onboarding

Documentation vivante qui évolue avec le projet:

# Onboarding Développeur

## Prérequis
- Node.js 18+
- PostgreSQL 14+
- Redis 6+

## Étapes de Setup
1. Cloner le dépôt
2. Installer les dépendances: `npm install`
3. Copier `.env.example` vers `.env`
4. Lancer les migrations DB: `npm run db:migrate`
5. Démarrer serveur dev: `npm run dev`

## Problèmes Courants
- **Conflit de port**: Voir Tâche #189 pour résolution
- **Connexion DB**: Vérifier VPN si distant

Dernière mise à jour: Déc 2024

Rechercher Partout

La recherche NoteVault inclut:

• Titres et contenu des documents
• Descriptions et commentaires des tâches
• Noms de fichiers et pièces jointes
• Labels et tags

Recherche: "implémentation oauth"

Résultats:
├── NoteVault: ADR-002: Stratégie Auth
├── NoteVault: Design API > Authentification
├── Tâche #234: Implémenter login OAuth
└── Tâche #235: Ajouter gestion session

Meilleures Pratiques pour Documentation Intégrée

1. Documentez les décisions près des tâches — Liez ADRs au travail lié
2. Mettez à jour docs avec le code — Partie de la checklist PR
3. Utilisez structure cohérente — Templates pour types communs de doc
4. Liez libéralement — Connectez docs aux tâches au code
5. Archivez, ne supprimez pas — Gardez l'historique accessible
6. Assignez propriété des docs — Quelqu'un responsable de la fraîcheur

Migration depuis Autres Outils

Depuis Confluence/Notion

1. Exporter en Markdown (ou HTML → Markdown)
2. Créer structure de dossiers correspondante dans NoteVault
3. Importer les documents
4. Ajouter liens vers tâches
5. Mettre à jour liens internes

Depuis Google Docs

1. Télécharger en .docx ou copier contenu
2. Coller dans NoteVault (auto-convertit formatage)
3. Organiser dans dossiers projet
4. Lier aux tâches pertinentes

Solutions Connexes

• Base de connaissances développeurs
• Gestion documentation technique
• Workflow documentation projet