Progetto personale · Tooling
Doclify Guardrail: controllare la documentazione di un repository
Una CLI pubblicata su npm che controlla link, comandi e riferimenti nei file Markdown e MDX di un repository. Per trovare quello che non torna prima di chi legge.
Il problema
Una documentazione può essere scritta bene e rimandare a un file che non esiste più. Può anche indicare un comando che il progetto non espone. Doclify Guardrail nasce per controllare questi riferimenti nel contesto del repository.
Cosa ho costruito
Una CLI pubblicata su npm che analizza file Markdown e MDX e segnala problemi nei link, nei comandi e nei riferimenti. Il progetto porta una parte della revisione documentale vicino al codice: il controllo diventa ripetibile e può entrare nel lavoro di verifica del repository.
Come valutarlo
Nel repository pubblico trovi implementazione, istruzioni e test. Il caso interessante è una documentazione che cambia insieme al software, anche quando alla scrittura partecipano strumenti IA. I controlli automatici aiutano a trovare incoerenze; il significato delle spiegazioni richiede comunque una revisione.