this repo has no description
new article for jit documentation
+63
-1
-1
components.d.ts
-1
components.d.ts
···
14
14
CrcProject: typeof import('./src/components/architecture/crc-project.vue')['default']
15
15
ForgettingCurve: typeof import('./src/components/smart-notes/forgetting-curve.vue')['default']
16
16
FormInput: typeof import('./src/components/design-system/form/FormInput.vue')['default']
17
-
Island: typeof import('./node_modules/.pnpm/iles@0.9.5_rollup@2.79.1_sass@1.62.1/node_modules/iles/dist/client/app/components/Island.vue')['default']
18
17
JulienCalixte: typeof import('./src/components/core/julien-calixte.vue')['default']
19
18
MyProjects: typeof import('./src/components/presentation/my-projects.vue')['default']
20
19
OrderTag: typeof import('./src/components/core/order-tag.vue')['default']
+63
src/pages/posts/just-in-time-documentation.mdx
+63
src/pages/posts/just-in-time-documentation.mdx
···
1
+
---
2
+
title: Just in time documentation is the right documentation
3
+
illustration: https://cdn.jsdelivr.net/gh/jcalixte/static@master/doc-jit/doc-jit-cover.png
4
+
layout: post
5
+
date: 2023-05-29
6
+
---
7
+
8
+
# Just in time documentation is the right documentation
9
+
10
+
## Falling over the same trap again and again
11
+
12
+
Many times a problem occurs where new developers fall over the same trap again and again despite the fact that the solution has been well documented. How can it be their fault? They didn't even know the documentation existed!
13
+
14
+
The eternal question of "do we write documentation for our project?"... But if no one read it when it needs to, the documentation becomes waste.
15
+
16
+
## Just in time
17
+
18
+
_Just in time_ (`jit`) is a lean concept: the goal for a team is to produce the right amount of value when the client needs it. No less no more.
19
+
20
+
So I created a VS Code extension doing exactly that: [doc-jit](https://marketplace.visualstudio.com/items?itemName=jcalixte.doc-jit). It provides the right amount of knowledge the exact moment the developper needs it: _just in time documentation_. 🤎
21
+
22
+
## How does it work?
23
+
24
+
You set glob patterns that is affiliated with a documentation file and [doc-jit](https://marketplace.visualstudio.com/items?itemName=jcalixte.doc-jit) will propose you when your active file matches at least one of them.
25
+
26
+
```json
27
+
// .doc-jitrc.json
28
+
{
29
+
"patterns": {
30
+
"**/*.test.ts, **/*.test.tsx": [
31
+
{
32
+
"label": "Jest documentation",
33
+
"uri": "https://jestjs.io/docs/getting-started"
34
+
},
35
+
{
36
+
"label": "Vitest documentation",
37
+
"uri": "https://vitest.dev/guide/"
38
+
}
39
+
],
40
+
"**/*.test.tsx": [
41
+
{
42
+
"label": "React Native testing library documentation",
43
+
"uri": "https://callstack.github.io/react-native-testing-library/docs/getting-started"
44
+
}
45
+
]
46
+
}
47
+
}
48
+
```
49
+
50
+
In real life, it looks like this:
51
+
52
+
<video controls autoplay loop preload="none" playsinline muted>
53
+
<source
54
+
src="https://cdn.jsdelivr.net/gh/jcalixte/static@main/doc-jit/docjit-tuto.webm"
55
+
type="video/webm"
56
+
/>
57
+
<source
58
+
src="https://cdn.jsdelivr.net/gh/jcalixte/static@main/doc-jit/docjit-tuto.mp4"
59
+
type="video/mp4"
60
+
/>
61
+
</video>
62
+
63
+
It's that simple and you can start with ease. For example, just your dependencies first, it's surprisingly powerful. Then add your own documentation, standards, tutorial, videos, etc. One problem solving at a time. Just in time. 😊