Administration : Tenue/Génération des Notes de configuration.

[dezix]

Bonjour,

Je tiens autant que possible des notes sur les installations et les configurations des divers systèmes dont j'ai la charge.

Jusqu'à présent, j'ai toujours fait cela manuellement dans des blocs-notes Zim

Zim est un très bon outil, je n'ai rien à lui reprocher, il fait son job ;
c'est la méthode en soit qui est à revoir.

Relisant une note sur la Méthode AGILE dont l'un des principes de base est :

Produit fonctionnel plutôt qu'une documentation exhaustive.

à la lueur de cette maxime,

je me rends compte que je passe un temps incroyable à documenter répétitivement chaque installation, chaque test, etc...
c'en est devenu une sorte de mal invalidant.


L'idée première qui me viens pour arranger cela :

1. Tenir une fiche d'historique pour chaque système, comportant la date et une très courte description de chaque point.
2. Inclure les notes explicatives directement sous forme de commentaires dans les fichiers du système.

Que pensez-vous de cela ?...

et surtout comment extraire et reconstituer une documentation facilement utilisable ?



J'imagine un système de comparaison et extraction des diffs entre un état initial du système et son état actuel.

À ce stade, un dépôt git sur la racine me semble une possibilité (pas testé),
mais avant de me lancer dans des tests laborieux et sans garantie de résultat,

je préfère vous demander vos avis et retours sur vos pratiques...

... plutôt que de faire (une fois de plus) le hamster qui réinvente sa roue

Je suppose que c'est un classique, mais j'ai trouvé assez peu d'info en 1ère recherche

Merci d'avance.

[piratebab]

Ce que tu decris ressemble fort à un gestionanire de versions (git ou autre).
J'ai lu recement qu'il valait mieux passer du temps à nommer les variables et les fonctions avec des noms explicites , plutot que d'écrire des commentaires que personnes ne lis. Ci ça peux aider ta réflexion ....

[dezix]

Ce que tu decris ressemble fort à un gestionanire de versions (git ou autre).

Oui, ça peut !

Ne plus avoir la totalité des modifs enregistrées et organisées selon ma routine va me demander une adaptation,
mais si j'y gagne en efficacité et en temps, alors ça vaudra le coup...

Je vais commencer en utilisant etckeeper + GIT
en parallèle avec mes notes habituelles que j'allégerai à mesure de la prise en main
ou de l'introduction d'autres outils ....

etckeeper fait des commits automatiques lorsque APT remplace des fichiers
et il permet aussi des commits manuels.

Comme j'ai déjà une petite pratique avec GIT, j'espère que la prise en main sera assez directe.


Je reviens pour un retour après une période d'essai.
Je reste à l'écoute d'autres idées bien sûr, les plus simples étant les meilleures à mes yeux.
Merci.

[vv222]

Gaffe avec la méthode "Agile" : elle est à destination d’entreprises fournissant un service payant à des clients, et n’a pas vraiment de sens dans le cadre d’activités personnelles.

[dezix]

Gaffe avec la méthode "Agile"

Merci de t’inquiéter pour moi,
mais un peu d'agilité va dynamiser un peu mes projets...

... ça rame grave, j'attaque la falaise !

[piratebab]

C'est qui ce Gilles qui a fait une méthode aussi populaire en entreprise ?

[MicP]

C'est qui ce Gilles …

Probablement un belge

[lol]

Salut,
Moi j'ai un Mediawiki (Privé) avec mes notes, mes trucs, mes installations.
Avec un peu de rigueur dans l'affectation des catégories on s'y retrouve très bien, c'est accessible de partout, et on peut y mettre des captures et des fichiers joints.

[dezix]

Moi j'ai un Mediawiki (Privé) avec mes notes, mes trucs, mes installations.

ça rejoint assez ce que je fais avec Zim qui est (à mon avis) beaucoup plus simple et léger que médiawiki qui nécessite PHP et une DB SQL,
mais là c'est vraiment une question d'habitude perso à tels ou tels outils.

Zim étant entièrement basé sur du texte plat et python, est aussi très facile à avoir partout
j'utilise un dépôt Git "nu" ( git init --bare ) sur une clé usb comme dépôt central sur lequel "je synchronise" les diverses copies.

C'est moins immédiat que ton wiki, mais ça fonctionne sans connexion, serveur,.... et chaque copie du dépôt est une sauvegarde potentielle.

Notez que Zim intègre l'usage d'un système de contrôle de versions

[piratebab]

J'utilise aussi vim, mais pour un recueil de trucs et astuces, et pour rédiger les articles de mon blog canin