1Objet

Le Kit est la base commune des sous-sites. Ce document décrit comment un sous-site se présente à ses lecteurs, ce qu’il conserve en dehors de cette présentation, et à quelle condition cette seconde partie devient publique.

Il vaut pour tout projet consommateur. Les mécanismes décrits appartiennent au Kit; leur contenu appartient au projet.

2Deux parties

Chaque sous-site traite un sujet — une revue de presse, un inventaire d’équipement, un dossier familial, la documentation d’un outil. Il comporte deux parties, présentes dès la première session.

Partie Contient Lecteur
Exposée Le sujet lui-même, et une page expliquant comment lire l’affichage Qui vient consulter
Technique Documentation de fonctionnement, Prompt, feuilles de style et modules propres, générateurs, Registry Qui maintient le projet
Note:La partie technique n’est pas un supplément: elle existe parce que c’est ainsi qu’un projet du Kit se conduit. Elle sert d’abord son auteur et quiconque en reprend la maintenance, publiée ou non.

3La décision de partager

À un moment, la partie technique d’un sous-site peut être empaquetée et rendue téléchargeable. C’est une décision, prise ou non; ne pas la prendre est un état stable, non un travail inachevé.

Le critère n’est pas la maturité de la documentation mais l’intérêt pour un tiers. Un projet peut être documenté avec soin et n’avoir rien à offrir à personne — un dossier familial, un inventaire personnel. La question est: quelqu’un d’autre en tirerait-il quelque chose.

–Ce que la décision produit. Un fichier téléchargeable, nommé d’après le sous-site: Kit-News, Kit-Testament. En prose, le kit du sous-site news. Le nom de fichier porte sa version — kit-news-1.4.zip — comme le Kit porte la sienne.

–Ce qu’elle rend visible. La phrase de bas de page et l’icône de téléchargement, qui ne se rendent pas sans elle. La page expliquant l’affichage, elle, existe indépendamment.

Note:Le Kit est la base commune de tous les sous-sites; le kit d’un sous-site est ce que ce sous-site remet à qui veut le reprendre. Ne pas écrire “le Kit” seul pour désigner le second.

4Ce que contient un kit de sous-site

Il contient de quoi reproduire le sous-site, non de quoi le décrire. Un dépôt de documents sans chaîne de production ne remplit pas le contrat.

–Documentation de fonctionnement. Ce que le sous-site produit, d’où viennent ses données, comment une passe se déroule.

–Prompt du projet. Les instructions permanentes: conventions, contraintes, ce qui ne se décide plus.

–Feuilles de style et modules propres. Ce que le projet a ajouté au Kit, et les tables qu’il déclare.

–Générateurs et Registry. La chaîne de production, et ce qui déclare son état actif.

Note:Un lecteur technique doit pouvoir savoir par où commencer, non tout comprendre avant de démarrer. Le sommaire ouvre donc sur ce qui se change, non sur l’architecture: les questions se posent dans cet ordre.

5Deux lecteurs

Les deux parties servent deux lecteurs, dont les besoins ne se recouvrent pas.

Lecteur Cherche Reçoit
Consultant Comprendre ce qu’il a sous les yeux Une explication courte de l’affichage
Repreneur Reproduire ce qu’il voit La documentation et le kit du sous-site
Note:Ce qui manque au premier porte sur l’affichage — ordre des blocs, groupement, horodatage — non sur le projet. Le second sait ce qu’il cherche: il lui faut un kit qui tourne, non sa description.

6Trois accès

Chaque accès est placé là où son lecteur regarde, et ne se rend que si le projet le déclare.

Accès Emplacement Mène à
Badge d’information Haut de la page consultée, défile avec le texte Explication de l’affichage
Phrase de bas de page Fin du sommaire de la documentation Instructions d’adaptation
Icône de téléchargement Barre du sommaire Le kit du sous-site
Note:Le badge défile avec le texte: un élément fixe se lit comme du mobilier et cesse d’être cliqué. La phrase vient après le contenu, de sorte que le lecteur venu consulter ne la rencontre qu’en descendant. Aucun des trois n’interrompt la lecture.

7Répartition

Le Kit fournit le mécanisme, le projet fournit ce qu’il porte.

Le Kit fournit Le projet fournit
La barre, ses emplacements, les deux sélecteurs de langue Nom du site, langues publiées, cible de l’icône
Les deux formes de page destinée au lecteur Les mots qu’elles portent
Le mécanisme de téléchargement et son contrat Le contenu de son kit, s’il en publie un
La palette et le moyen de la remplacer Ses couleurs, s’il en déclare
La règle: un élément non déclaré ne se rend pas Ses déclarations, donc ce qui se rend
La règle: aucun lien souligné, dans aucun état Rien — la règle ne se déclare pas
Note:Un emplacement d’icône, non un calendrier. Une page de prose, non un texte de présentation. Un contrat de téléchargement, non un kit.
Note:Aucun lien n’est souligné, dans aucun état. La couleur porte l’affordance et le curseur en main la confirme; un soulignement au survol n’existe pas sur écran tactile et ne servirait donc que la moitié des lecteurs.

8Règles

–Renseigner sur demande. Les trois accès répondent à qui les emprunte et restent silencieux autrement. Leur rendu dépend d’une déclaration du projet.

–Une seule publication. Le kit d’un sous-site est servi depuis les mêmes pages que son sujet. Rien n’est dupliqué, aucune section n’est réservée.

–Kit exécutable. Un kit publié se dépaquette et produit le site. Ce qui ne tourne pas ne se publie pas.

–Aucun engagement de suite. Un kit publié doit être complet et exact. Son usage par un tiers reste son affaire.