Computer Science Book Validation : A Structured Approach

Abstract

The report focuses on addressing structural and semantic challenges in validating large-scale technical documentation written in Microdown, a lightweight markup language used within the Pharo ecosystem. The thesis presents the design and implementation of an automated Book Validation Tool, aimed at ensuring the integrity and correctness of documents. The tool systematically checks for structural problems like missing files, cyclic references, and anchor issues, as well as semantic problems such as code block errors and inconsistencies. The solution utilizes advanced validation strategies, applying design patterns such as Strategy and Visitor to enhance flexibility and scalability. Through continuous testing and validation, the tool supports documentation consistency, particularly in evolving codebases. ***

Le rapport se concentre sur la résolution des défis structurels et sémantiques dans la validation de la documentation technique à grande échelle écrite en Microdown, un langage de balisage léger utilisé dans l’écosystème Pharo. Le mémoire présente la conception et la mise en oeuvre d’un outil de validation automatisée des livres, visant à garantir l’intégrité et la précision des documents. L’outil vérifie systématiquement les problèmes structurels tels que les fichiers manquants, les références cycliques et les problèmes d’ancrage, ainsi que les problèmes sémantiques tels que les erreurs dans les blocs de code et les incohérences. La solution utilise des stratégies de validation avancées en appliquant des motifs de conception tels que la Stratégie et le Visiteur pour améliorer la flexibilité et l’évolutivité. Grâce à des tests et des validations continus, l’outil soutient la cohérence de la documentation, notamment dans les bases de code en évolution.