Aller au contenu

Noms et termes

Comment nommer le projet, les domaines, les instances, les zones produit et les surfaces generees.

Utilisez des noms coherents pour distinguer le produit, le site public, le site de marque et les surfaces de redirection generees.

Projet et domaines

NomUtilisation
vanityURLsNom du projet et du produit
vanityURLs.linkDomaine public de documentation et de produit
brand.vanityURLs.linkDomaine des standards de marque et du systeme de design
v8s.linkInstance de demo, exemples de badges et exemples compacts

Gardez le style vanityURLs dans le texte. Dans les URLs et noms d’hote, utilisez la casse reelle seulement quand elle aide la reconnaissance; DNS n’est pas sensible a la casse.

Termes produit

TermeSens
RedirectionRequete de lien court resolue vers une cible configuree
AliasChemin court ou mot-cle utilise pour atteindre une cible
InstanceRedirecteur deploye avec les valeurs par defaut ou surchargees
Page genereePage produite par le redirecteur pour l’expansion ou le repli
BadgeLien visuel compact qui annonce ou previsualise un alias
OperateurPersonne qui configure, deploie ou audite une instance

Regles d’ecriture

  • Preferez les termes produit aux synonymes inventes.
  • Definissez un terme a sa premiere apparition dans une page pour debutants.
  • Utilisez le format code pour les chemins, hotes, commandes, variables d’environnement, jetons et fichiers litteraux.
  • Gardez les affirmations legales ou de marque factuelles et minimales jusqu’a l’existence d’une politique formelle.