BACKSIC

Code, Devlog, Actualités

Inspection Générale

devlog
Opération réécriture de la documentation. Oui, après un an d'évolutions accumulées, le terme opération n'est pas de trop.
Mardi 2 Decembre 2025
C'est le moment qu'il n'était plus possible d'éviter : remettre toute la documentation au clair. Mais on ne se lance pas dans une dangereuse expédition sans un minimum de préparation.

D'abord, il a fallu reconstuire une interface d'aide digne de ce nom. Avec d'un côté le panneau d'aide contextuel à utiliser en pleine séance de code, et de l'autre la version studieuse organisée en rubriques. Après un nombre honorable d'aller-retour le résultat est plutôt satisfaisant.

Mais ensuite, il restait à attaquer réellement la documentation...


RFTM

Le fait de réécrire tous les articles laisse l'occasion de repasser sur chaque instruction du langage, l'une après l'autre. Et ce petit temps en tête à tête... est parfait pour remarquer le petit détail qui coince. Quelque chose d'illogique, de contradictoire avec un autre point, ou avec une logique un peu trop "développeur".

Voici donc la documentation abandonnée régulièrement au milieu d'une phrase, pour devoir aller mettre à jour le langage, corriger l'hérésie, puis seulement ensuite pouvoir venir finir la phrase.

Too much Power

Par exemple... la fonction Power (pour élever un nombre à une puissance) et la fonction... Power pour régler la puissance d'une lumière. Une distinction s'imposait...

Sélection naturelle

Ou ce moment en écrivant la documentation de "trace background" où une cruelle constation s'est imposée : la même explication avait déjà été écrite pour "fill screen". Oui : deux instructions qui font exactement la même chose. La première n'était sans doute pas assez intuitive, elle avait donc été recréé sous un autre nom... c'est d'ailleurs cette seconde qui restera.

La moitié de la documentation a été revue.
L'opération documentation  vérification générale continue...
© 2026

backsic.org

horc.fr