Manuel pratique Comp’Assist · Révision : 2 octobre 2026. Exemples pédagogiques, à adapter. Les fonctions visibles dépendent de la version, des droits et des paquets installés.
Choisir des chemins stables, courts et regroupés par thème. Un titre peut évoluer sans changer l’URL ; un déplacement exige de vérifier les liens. La navigation est un accès rapide, pas une barrière de sécurité. Une page cachée du menu peut rester accessible par URL, recherche ou API si les droits le permettent.
| Champ | Comment remplir | Contrôle |
|---|---|---|
| Titre | Sujet concret et action comprise | Éviter les promesses de sécurité absolue |
| Chemin | Rubrique/sujet stable | Vérifier les liens existants avant renommage |
| Description | Résumé du résultat attendu | Sert au catalogue et à la recherche |
| Langue | Langue effective du contenu | Liens vers le bon préfixe de langue |
| Tags | Quelques termes utiles | Ne remplacent pas les droits |
| Éditeur | Markdown ou éditeur maîtrisé | Vérifier rendu des tableaux et blocs de code |
| Publication | Brouillon ou publié selon validation | Aperçu puis test dans une autre session |
Inclure prérequis, version, paramètres, procédure, résultat attendu, erreurs et retour arrière. Les commandes de lecture sont distinguées des écritures. Les exemples n’incluent pas de mot de passe ni d’adresse réelle interne lorsqu’ils sont publics.
Attribuer permissions globales et règles par chemin selon le modèle Wiki.js. Une permission de lecture et une règle de chemin doivent être cohérentes. Les correspondances exactes et par préfixe n’ont pas la même portée. Une autorisation trop large à la racine peut rendre les pages internes visibles.
Tester en visiteur anonyme la page, la recherche, les assets joints, l’historique et les API accessibles. Tester aussi les refus d’écriture. Une image d’infrastructure peut être accessible par son URL même si la page qui l’affiche est privée : vérifier les droits des fichiers séparément.
Utiliser des libellés compréhensibles et regrouper les manuels, sans multiplier les liens qui mènent au même écran. L’espace interne apparaît seulement aux groupes concernés, mais ses droits restent appliqués même lorsque le lien est connu. Le logo public doit être un fichier prévu pour diffusion, sans métadonnées ou captures privées.
Sauvegarder base, configuration et assets. Dans une installation SQLite, utiliser une copie cohérente par mécanisme adapté, pas une copie arbitraire d’un fichier actif sans ses contraintes. Protéger les archives hors du répertoire Web et tester leur restauration. Mettre à jour runtime et application selon compatibilité, avec un compte de service limité.
Pour une veille automatique, limiter la clé à la page nécessaire, dater tentative et dernier succès, conserver le contenu précédent si la source est indisponible. Le contenu d’un flux externe reste non fiable : ne pas l’exécuter ni lui laisser modifier des permissions. Une date de collecte récente ne prouve pas qu’un avis s’applique à votre installation.
Relire les liens, unités, valeurs d’exemple et avertissements. Ouvrir sur ordinateur et écran étroit ; les tableaux doivent rester lisibles. Tester un lecteur débutant : peut-il retrouver le menu, comprendre le champ et reconnaître un échec sans deviner ? Corriger les ambiguïtés avant publication et conserver l’historique des changements.