Documentation
La documentation c'est comme de la pizza. Quand elle est bonne, c'est cool. quand elle est pas hyper bien... c'en est quand même.
Prends l'habitude d'écrire de la doc. A l'ère de l'IA, tu n'a plus AUCUNE excuse pour ne pas avoir de doc.
Documentation Claude
Si tu utilises Claude Code dans ton projet, tu peux lui demander de garder une documentation dans son dossier .claude/docs/....
Avec ça, tu peux ajouter cela dans ton fichier .gitlab-ci.yml:
include:
- component: $CI_SERVER_FQDN/spektrum/ci-templates/sync-claude-docs@1
stages:
- <autres stages que tu as>
- docs # si tu ne l'as pas déjà.ça mettra à disposition ta documentation à l'équipe.
INFO
Le job qui upload ta doc vers l'équipe se déclenche sous deux conditions:
- il y a eu des modifications dans le dossier
.claude/docs/... - tu es sur la branche principale
Pour que Claude Code puisse accéder à la doc, tu peux ajouter un une configuration de serveur MCP:
// .mcp.json dans ton repository
{
"mcpServers": {
"internal-docs": {
"type": "http",
"url": "https://mcp-doc.internal.spektrum-suisse.ch/mcp"
}
}
}Et notes dans CLAUDE.md qu'il peut aller chercher des infos là bas si besoin.
Documentation générée et interview
Pour faciliter le transfert de connaissances et accompagner Claude dans son travail, vous pouvez copier le contenu du fichier _claude-interview.md et le coller dans Claude. Il pourra ainsi vous aider à créer la documentation technique du projet.
Ce fichier est également très pratique pour conserver les connaissances liées au projet, puisqu’il indique à Claude qu'il doit mettre à jour automatiquement la documentation au fur et à mesure du développement.
Markdown ++
Vu qu'on utilise VitePress, on peut utiliser du markdown un peu plus avancé. Va voir la référence pour voir tout ce qui est possible.
export default {
data () {
return {
msg: 'Par exemple on peut faire ça!'
}
}
}WARNING
On peut aussi faire ça! 😱
DrawIO
On a ajouté un plugin pour afficher les schémas draw.io sans avoir besoin de les exporter en png à chaque foid. (Va voir la page cloud layout pour voir un exemple.) Vu qu'on a une extension draw.io dans l'éditeur, tu peux tout faire depuis là.
| Serveur | Addresse |
|---|---|
| NGINX-Internal | 84.234.26.160 |
Contributors
Clément Favre