living-documentation 8.13.0 → 8.15.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -14,10 +14,9 @@ Before changing the project:
14
14
  4. Read `DOCS_FOLDER/AI/PROJECT-USEFUL-COMMANDS.md` to know the development, build, test, lint, and setup commands.
15
15
  5. Read `memory/MEMORY.md` and load only the memory files relevant to the task.
16
16
  6. Read every rule in `DOCS_FOLDER/AI/rules/*.md`.
17
- 7. Inspect existing ADRs: list `DOCS_FOLDER/ADRS/`, read only `description` and `tags` first, then open the full ADR only when relevant.
18
- 8. Check whether the Living Documentation MCP server is available before creating or modifying documentation.
19
-
20
- Replace `DOCS_FOLDER` with the real documentation folder used by this project, for example `documentation`, `docs`, or `doc`.
17
+ 7. Read `DOCS_FOLDER/WORKLOG/current-task.md` if present to resume the state of the current task.
18
+ 8. Inspect existing ADRs: list `DOCS_FOLDER/ADRS/`, read only `description` and `tags` first, then open the full ADR only when relevant.
19
+ 9. Check whether the Living Documentation MCP server is available before creating or modifying documentation.
21
20
 
22
21
  ## Living Documentation MCP
23
22
 
@@ -52,6 +51,24 @@ Create or update a document when the change:
52
51
 
53
52
  Do not create durable documentation for trivial fixes, mechanical renames, or formatting-only changes.
54
53
 
54
+ ## Progress Tracking
55
+
56
+ The `DOCS_FOLDER/WORKLOG/` folder holds the operational state of in-progress tasks and the resume points between AI assistants. It does not replace ADRs.
57
+
58
+ `DOCS_FOLDER/WORKLOG/current-task.md` is the shared resume point. Every assistant must read it before resuming a task and update it before handing over when it has started, finished, interrupted, or left a known follow-up.
59
+
60
+ The worklog must stay factual and useful for the next agent:
61
+
62
+ - current status;
63
+ - task in progress;
64
+ - in-scope and out-of-scope items if needed;
65
+ - files or areas concerned;
66
+ - verifications performed;
67
+ - remaining verifications;
68
+ - next recommended action.
69
+
70
+ Create a dedicated document under `DOCS_FOLDER/WORKLOG/` for an MVP ticket when more detailed tracking becomes necessary. Durable decisions stay in ADRs.
71
+
55
72
  ## ADRs
56
73
 
57
74
  ADRs are the log of architecture and design decisions. They should stay short, traceable, and useful for deciding what to change later.
@@ -9,8 +9,9 @@ Before making changes:
9
9
  3. Read `DOCS_FOLDER/AI/PROJECT-USEFUL-COMMANDS.md` to know the development, build, test, lint, and setup commands.
10
10
  4. Read `memory/MEMORY.md` and load only useful memory files.
11
11
  5. Read rules in `DOCS_FOLDER/AI/rules/*.md`.
12
- 6. Inspect ADRs in `DOCS_FOLDER/ADRS/` by reading `description` and `tags` first, then open the full ADR only when relevant.
13
- 7. Check whether the `living-documentation` MCP is available and use it to create, update, and keep documentation reliable when the task touches a decision, rule, command, stack, or technical document.
12
+ 6. Read `DOCS_FOLDER/WORKLOG/current-task.md` if present to resume the state of the current task.
13
+ 7. Inspect ADRs in `DOCS_FOLDER/ADRS/` by reading `description` and `tags` first, then open the full ADR only when relevant.
14
+ 8. Check whether the `living-documentation` MCP is available and use it to create, update, and keep documentation reliable when the task touches a decision, rule, command, stack, or technical document.
14
15
 
15
16
  ## Living Documentation MCP
16
17
 
@@ -9,8 +9,9 @@ Before making changes:
9
9
  3. Read `DOCS_FOLDER/AI/PROJECT-USEFUL-COMMANDS.md` to know the development, build, test, lint, and setup commands.
10
10
  4. Read `memory/MEMORY.md` and load only useful memory files.
11
11
  5. Read rules in `DOCS_FOLDER/AI/rules/*.md`.
12
- 6. Inspect ADRs in `DOCS_FOLDER/ADRS/` by reading `description` and `tags` first, then open the full ADR only when relevant.
13
- 7. Check whether the `living-documentation` MCP is available and use it to create, update, and keep documentation reliable when the task touches a decision, rule, command, stack, or technical document.
12
+ 6. Read `DOCS_FOLDER/WORKLOG/current-task.md` if present to resume the state of the current task.
13
+ 7. Inspect ADRs in `DOCS_FOLDER/ADRS/` by reading `description` and `tags` first, then open the full ADR only when relevant.
14
+ 8. Check whether the `living-documentation` MCP is available and use it to create, update, and keep documentation reliable when the task touches a decision, rule, command, stack, or technical document.
14
15
 
15
16
  ## Living Documentation MCP
16
17
 
@@ -0,0 +1,23 @@
1
+ ---
2
+ id: track-current-work
3
+ title: Track the current task in WORKLOG
4
+ severity: required
5
+ description: AI assistants must read and maintain the current-task worklog to enable reliable handoff between agents.
6
+ tags: ["worklog", "handoff", "ai-agents", "progress", "documentation"]
7
+ appliesTo: ["**/*"]
8
+ ---
9
+
10
+ Before resuming or modifying the project, read `DOCS_FOLDER/WORKLOG/current-task.md` if the file exists.
11
+
12
+ When a task is started, interrupted, finished, or left with known follow-ups, update `DOCS_FOLDER/WORKLOG/current-task.md` with:
13
+
14
+ - the current status;
15
+ - the task in progress;
16
+ - the files or areas concerned;
17
+ - the verifications performed;
18
+ - the remaining verifications;
19
+ - the next recommended action.
20
+
21
+ For an MVP ticket that has actually started, create or update a dedicated document under `DOCS_FOLDER/WORKLOG/` if the tracking no longer fits clearly in `current-task.md`.
22
+
23
+ The worklog does not replace ADRs: it describes operational progress and resume points, not durable decisions.
@@ -0,0 +1,57 @@
1
+ ---
2
+ **date:** 2026-01-02
3
+ **status:** Idle
4
+ **description:** Shared resume point between AI assistants to track the current task, its status, the files touched, the verifications, and the next action.
5
+ **tags:** worklog, handoff, progress, resume, ai-agents
6
+ ---
7
+
8
+ # Current task
9
+
10
+ This document is the shared resume point between AI assistants. Every agent must read it before continuing a task and update it before handing over.
11
+
12
+ ## Current status
13
+
14
+ Idle
15
+
16
+ ## Current task
17
+
18
+ No application implementation task is currently in progress.
19
+
20
+ ## Last action performed
21
+
22
+ Added the progress-tracking convention between AI assistants:
23
+
24
+ - created this current worklog;
25
+ - created the mandatory rule `track-current-work`;
26
+ - added the worklog read step in `AGENTS.md`, `CLAUDE.md` and `PROJECT-INSTRUCTIONS.md`.
27
+
28
+ ## Next recommended action
29
+
30
+ Start Ticket 01: initialize the React + TypeScript + Vite + Tailwind frontend project, then update this worklog with the files created, the verifications run, and any resume points.
31
+
32
+ ## Files or areas concerned
33
+
34
+ - `AGENTS.md`
35
+ - `CLAUDE.md`
36
+ - `DOCS_FOLDER/AI/PROJECT-INSTRUCTIONS.md`
37
+ - `DOCS_FOLDER/AI/rules/track-current-work.md`
38
+ - `DOCS_FOLDER/WORKLOG/current-task.md`
39
+ - `DOCS_FOLDER/PRODUCT/`
40
+ - `DOCS_FOLDER/TECHNICAL/`
41
+ - `DOCS_FOLDER/ROADMAP/`
42
+ - `DOCS_FOLDER/ADRS/`
43
+ - `DOCS_FOLDER/AI/PROJECT-STACK.md`
44
+ - `DOCS_FOLDER/AI/PROJECT-USEFUL-COMMANDS.md`
45
+
46
+ ## Recent verifications
47
+
48
+ - Living Documentation MCP available.
49
+ - `WORKLOG/current-task` visible in the MCP inventory.
50
+ - `AI/rules/track-current-work` visible in the MCP inventory.
51
+ - ADRs created with metadata and accuracy `1`.
52
+ - `PROJECT-STACK` with metadata and accuracy `1`.
53
+ - No ADR below the reliability threshold.
54
+
55
+ ## Resume notes
56
+
57
+ The repository does not contain any application code yet. Do not assume the existence of `package.json`, `src/`, npm scripts, tests, or Tailwind configuration before Ticket 01.
@@ -14,8 +14,9 @@ Avant de modifier le projet :
14
14
  4. Lire `DOCS_FOLDER/AI/PROJECT-USEFUL-COMMANDS.md` pour connaître les commandes de développement, build, test, lint et setup.
15
15
  5. Lire `memory/MEMORY.md` et charger seulement les fichiers mémoire utiles à la tâche.
16
16
  6. Lire toutes les règles dans `DOCS_FOLDER/AI/rules/*.md`.
17
- 7. Inspecter les ADR existants : lister `DOCS_FOLDER/ADRS/`, lire d'abord `description` et `tags`, puis ouvrir l'ADR complet seulement s'il est pertinent.
18
- 8. Vérifier si le MCP `living-documentation` est disponible avant de créer ou modifier de la documentation.
17
+ 7. Lire `DOCS_FOLDER/WORKLOG/current-task.md` si présent pour reprendre l'état de la tâche courante.
18
+ 8. Inspecter les ADR existants : lister `DOCS_FOLDER/ADRS/`, lire d'abord `description` et `tags`, puis ouvrir l'ADR complet seulement s'il est pertinent.
19
+ 9. Vérifier si le MCP `living-documentation` est disponible avant de créer ou modifier de la documentation.
19
20
 
20
21
  ## Rôle du MCP Living Documentation
21
22
 
@@ -50,6 +51,24 @@ Créer ou mettre à jour un document lorsque le changement :
50
51
 
51
52
  Ne pas créer de documentation durable pour les corrections triviales, renommages mécaniques ou changements de formatage.
52
53
 
54
+ ## Suivi de progression
55
+
56
+ Le dossier `DOCS_FOLDER/WORKLOG/` contient l'état opérationnel des tâches en cours et les points de reprise entre assistants IA. Il ne remplace pas les ADR.
57
+
58
+ `DOCS_FOLDER/WORKLOG/current-task.md` est le point de reprise partagé. Tout assistant doit le lire avant de reprendre une tâche et le mettre à jour avant de rendre la main lorsqu'il a commencé, terminé, interrompu ou laissé une suite connue.
59
+
60
+ Le worklog doit rester factuel et utile pour l'agent suivant :
61
+
62
+ - statut courant ;
63
+ - tâche en cours ;
64
+ - scope inclus et exclu si nécessaire ;
65
+ - fichiers ou zones concernés ;
66
+ - vérifications réalisées ;
67
+ - vérifications restantes ;
68
+ - prochaine action recommandée.
69
+
70
+ Créer un document dédié dans `DOCS_FOLDER/WORKLOG/` pour un ticket MVP lorsqu'un suivi plus détaillé devient nécessaire. Les décisions durables restent dans les ADR.
71
+
53
72
  ## ADR
54
73
 
55
74
  Les ADR sont le journal des décisions d'architecture et de conception. Ils doivent rester courts, traçables et utiles pour décider quoi modifier plus tard.
@@ -9,8 +9,9 @@ Avant toute modification :
9
9
  3. Lire `DOCS_FOLDER/AI/PROJECT-USEFUL-COMMANDS.md` pour connaître les commandes de développement, build, test, lint et setup.
10
10
  4. Lire `memory/MEMORY.md` et charger seulement les fichiers mémoire utiles à la tâche.
11
11
  5. Lire toutes les règles dans `DOCS_FOLDER/AI/rules/*.md`.
12
- 6. Inspecter les ADR dans `DOCS_FOLDER/ADRS/` en lisant d'abord `description` et `tags`, puis ouvrir l'ADR complet seulement s'il est pertinent.
13
- 7. Vérifier si le MCP `living-documentation` est disponible et l'utiliser pour créer, mettre à jour et fiabiliser la documentation lorsque la tâche touche une décision, une règle, une commande, la stack ou un document technique.
12
+ 6. Lire `DOCS_FOLDER/WORKLOG/current-task.md` si présent pour reprendre l'état de la tâche courante.
13
+ 7. Inspecter les ADR dans `DOCS_FOLDER/ADRS/` en lisant d'abord `description` et `tags`, puis ouvrir l'ADR complet seulement s'il est pertinent.
14
+ 8. Vérifier si le MCP `living-documentation` est disponible et l'utiliser pour créer, mettre à jour et fiabiliser la documentation lorsque la tâche touche une décision, une règle, une commande, la stack ou un document technique.
14
15
 
15
16
  ## MCP Living Documentation
16
17
 
@@ -9,8 +9,9 @@ Avant toute modification :
9
9
  3. Lire `DOCS_FOLDER/AI/PROJECT-USEFUL-COMMANDS.md` pour connaître les commandes de développement, build, test, lint et setup.
10
10
  4. Lire `memory/MEMORY.md` et charger seulement les fichiers mémoire utiles à la tâche.
11
11
  5. Lire toutes les règles dans `DOCS_FOLDER/AI/rules/*.md`.
12
- 6. Inspecter les ADR dans `DOCS_FOLDER/ADRS/` en lisant d'abord `description` et `tags`, puis ouvrir l'ADR complet seulement s'il est pertinent.
13
- 7. Vérifier si le MCP `living-documentation` est disponible et l'utiliser pour créer, mettre à jour et fiabiliser la documentation lorsque la tâche touche une décision, une règle, une commande, la stack ou un document technique.
12
+ 6. Lire `DOCS_FOLDER/WORKLOG/current-task.md` si présent pour reprendre l'état de la tâche courante.
13
+ 7. Inspecter les ADR dans `DOCS_FOLDER/ADRS/` en lisant d'abord `description` et `tags`, puis ouvrir l'ADR complet seulement s'il est pertinent.
14
+ 8. Vérifier si le MCP `living-documentation` est disponible et l'utiliser pour créer, mettre à jour et fiabiliser la documentation lorsque la tâche touche une décision, une règle, une commande, la stack ou un document technique.
14
15
 
15
16
  ## MCP Living Documentation
16
17
 
@@ -0,0 +1,23 @@
1
+ ---
2
+ id: track-current-work
3
+ title: Suivre la tâche courante dans WORKLOG
4
+ severity: required
5
+ description: Les assistants IA doivent lire et maintenir le worklog de tâche courante pour permettre une reprise fiable entre agents.
6
+ tags: ["worklog", "handoff", "agents-ia", "progression", "documentation"]
7
+ appliesTo: ["**/*"]
8
+ ---
9
+
10
+ Avant de reprendre ou modifier le projet, lire `DOCS_FOLDER/WORKLOG/current-task.md` si le fichier existe.
11
+
12
+ Quand une tâche est commencée, interrompue, terminée ou laissée avec des suites connues, mettre à jour `DOCS_FOLDER/WORKLOG/current-task.md` avec :
13
+
14
+ - le statut courant ;
15
+ - la tâche en cours ;
16
+ - les fichiers ou zones concernés ;
17
+ - les vérifications réalisées ;
18
+ - les vérifications restantes ;
19
+ - la prochaine action recommandée.
20
+
21
+ Pour un ticket MVP réellement commencé, créer ou mettre à jour un document dédié dans `DOCS_FOLDER/WORKLOG/` si le suivi ne tient plus clairement dans `current-task.md`.
22
+
23
+ Le worklog ne remplace pas les ADR : il décrit l'avancement opérationnel et les points de reprise, pas les décisions durables.
@@ -0,0 +1,57 @@
1
+ ---
2
+ **date:** 2026-01-02
3
+ **status:** Idle
4
+ **description:** Point de reprise partagé entre assistants IA pour suivre la tâche courante, son statut, les fichiers touchés, les vérifications et la prochaine action.
5
+ **tags:** worklog, handoff, progression, reprise, agents-ia
6
+ ---
7
+
8
+ # Current task
9
+
10
+ Ce document est le point de reprise entre assistants IA. Tout agent doit le lire avant de continuer une tâche et le mettre à jour avant de rendre la main.
11
+
12
+ ## Statut courant
13
+
14
+ Idle
15
+
16
+ ## Tâche courante
17
+
18
+ Aucune tâche d'implémentation applicative n'est en cours.
19
+
20
+ ## Dernière action réalisée
21
+
22
+ Ajout de la convention de suivi de progression entre assistants IA :
23
+
24
+ - création de ce worklog courant ;
25
+ - création de la règle obligatoire `track-current-work` ;
26
+ - ajout de la lecture du worklog dans `AGENTS.md`, `CLAUDE.md` et `PROJECT-INSTRUCTIONS.md`.
27
+
28
+ ## Prochaine action recommandée
29
+
30
+ Démarrer le Ticket 01 : initialiser le projet frontend React + TypeScript + Vite + Tailwind, puis mettre à jour ce worklog avec les fichiers créés, les vérifications lancées et les éventuels points de reprise.
31
+
32
+ ## Fichiers ou zones concernés
33
+
34
+ - `AGENTS.md`
35
+ - `CLAUDE.md`
36
+ - `DOCS_FOLDER/AI/PROJECT-INSTRUCTIONS.md`
37
+ - `DOCS_FOLDER/AI/rules/track-current-work.md`
38
+ - `DOCS_FOLDER/WORKLOG/current-task.md`
39
+ - `DOCS_FOLDER/PRODUCT/`
40
+ - `DOCS_FOLDER/TECHNICAL/`
41
+ - `DOCS_FOLDER/ROADMAP/`
42
+ - `DOCS_FOLDER/ADRS/`
43
+ - `DOCS_FOLDER/AI/PROJECT-STACK.md`
44
+ - `DOCS_FOLDER/AI/PROJECT-USEFUL-COMMANDS.md`
45
+
46
+ ## Vérifications récentes
47
+
48
+ - MCP Living Documentation disponible.
49
+ - `WORKLOG/current-task` visible dans l'inventaire MCP.
50
+ - `AI/rules/track-current-work` visible dans l'inventaire MCP.
51
+ - ADR créés avec métadonnées et accuracy `1`.
52
+ - `PROJECT-STACK` avec métadonnées et accuracy `1`.
53
+ - Aucun ADR sous le seuil de fiabilité.
54
+
55
+ ## Notes de reprise
56
+
57
+ Le dépôt ne contient pas encore de code applicatif. Ne pas supposer l'existence de `package.json`, `src/`, scripts npm, tests ou configuration Tailwind avant le Ticket 01.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "living-documentation",
3
- "version": "8.13.0",
3
+ "version": "8.15.0",
4
4
  "description": "Local Markdown documentation hub with a built-in MCP server — coding agents create ADRs, draw diagrams and detect drift while you code.",
5
5
  "main": "dist/src/server.js",
6
6
  "bin": {