1Gegenstand

Dieses Dokument ist eine sinngemäße Übersetzung. Maßgeblich ist das Originaldokument auf Französisch; Erweiterungen und Änderungen werden stets dort eingepflegt.

Das Kit ist die gemeinsame Grundlage der Subsites. Dieses Dokument beschreibt, wie sich eine Subsite ihren Lesern zeigt, was sie außerhalb dieser Darstellung führt, und unter welcher Bedingung dieser zweite Teil öffentlich wird.

Es gilt für jedes Projekt, das das Kit einsetzt. Die beschriebenen Mechanismen gehören dem Kit; ihr Inhalt gehört dem Projekt.

2Zwei Teile

Jede Subsite behandelt ein Thema — eine Presseschau, ein Geräteverzeichnis, eine Familienakte, die Dokumentation eines Werkzeugs. Sie hat zwei Teile, beide von der ersten Sitzung an vorhanden.

Teil Enthält Leser
Gezeigt Das Thema selbst und eine Seite, die die Darstellung erklärt Wer sie liest
Technisch Funktionsdokumentation, Prompt, eigene Stylesheets und Module, Generatoren, Registry Wer das Projekt pflegt
Hinweis:Der technische Teil ist keine Zugabe: er besteht, weil ein Kit-Projekt so geführt wird. Er dient zuerst seinem Autor und jedem, der die Pflege übernimmt — veröffentlicht oder nicht.

3Die Entscheidung zu teilen

Irgendwann kann der technische Teil einer Subsite gepackt und herunterladbar gemacht werden. Das ist eine Entscheidung, die getroffen wird oder nicht; sie nicht zu treffen ist ein stabiler Zustand, keine unfertige Arbeit.

Das Kriterium ist nicht die Reife der Dokumentation, sondern der Nutzen für Dritte. Ein Projekt kann sorgfältig dokumentiert sein und niemandem etwas zu bieten haben — eine Familienakte, ein persönliches Verzeichnis. Die Frage lautet: hätte jemand anderes etwas davon.

–Was die Entscheidung erzeugt. Eine herunterladbare Datei, benannt nach der Subsite: Kit-News, Kit-Testament. In Prosa: das Kit der Subsite news. Der Dateiname trägt seine Version — kit-news-1.4.zip — wie das Kit die seine.

–Was sie sichtbar macht. Den Satz am Seitenfuß und das Download-Symbol, die ohne sie nicht erscheinen. Die Seite, die die Darstellung erklärt, besteht davon unabhängig.

Hinweis:Das Kit ist die gemeinsame Grundlage aller Subsites; das Kit einer Subsite ist das, was diese Subsite dem übergibt, der sie übernehmen will. Für das Zweite nie “das Kit” allein schreiben.

4Was ein Subsite-Kit enthält

Es enthält, was zum Nachbau nötig ist, nicht was die Subsite beschreibt. Eine Ablage von Dokumenten ohne Herstellungskette erfüllt den Vertrag nicht.

–Funktionsdokumentation. Was die Subsite erzeugt, woher ihre Daten kommen, wie ein Durchlauf abläuft.

–Projekt-Prompt. Die dauerhaften Anweisungen: Konventionen, Randbedingungen, was nicht mehr entschieden wird.

–Eigene Stylesheets und Module. Was das Projekt dem Kit hinzugefügt hat, und die Tabellen, die es erklärt.

–Generatoren und Registry. Die Herstellungskette und das, was ihren aktiven Zustand erklärt.

Hinweis:Ein technischer Leser muss wissen können, wo er anfängt — nicht alles verstehen, bevor er beginnt. Das Verzeichnis öffnet daher mit dem, was sich ändern lässt, nicht mit der Architektur: in dieser Reihenfolge stellen sich die Fragen.

5Zwei Leser

Die zwei Teile bedienen zwei Leser, deren Bedarf sich nicht überschneidet.

Leser Sucht Erhält
Der Lesende Zu verstehen, was er vor sich hat Eine kurze Erklärung der Darstellung
Der Übernehmende Nachzubauen, was er sieht Dokumentation und Kit der Subsite
Hinweis:Dem ersten fehlt Wissen über die Darstellung — Reihenfolge, Gruppierung, Zeitangabe — nicht über das Projekt. Der zweite weiß, was er sucht: er braucht ein Kit, das läuft, keine Beschreibung davon.

6Drei Zugänge

Jeder Zugang liegt dort, wo sein Leser hinsieht, und erscheint nur, wenn das Projekt ihn erklärt.

Zugang Ort Führt zu
Info-Zeichen Oben auf der gelesenen Seite, scrollt mit Erklärung der Darstellung
Satz am Seitenfuß Ende des Dokumentationsverzeichnisses Anleitung zum Anpassen
Download-Symbol Leiste des Verzeichnisses Das Kit der Subsite
Hinweis:Das Zeichen scrollt mit: ein festes Element wird als Möbelstück gelesen und nicht mehr angeklickt. Der Satz steht nach dem Inhalt, sodass ihn nur erreicht, wer nach unten geht. Keiner der drei unterbricht das Lesen.

7Aufteilung

Das Kit liefert den Mechanismus, das Projekt das, was er trägt.

Das Kit liefert Das Projekt liefert
Die Leiste, ihre Plätze, die zwei Sprachauswahlen Name der Website, Sprachen, Ziel des Symbols
Die zwei Formen der Leserseite Die Worte, die sie tragen
Den Download-Mechanismus und seinen Vertrag Den Inhalt seines Kits, wenn es eines veröffentlicht
Die Palette und den Weg, sie zu ersetzen Seine Farben, wenn es welche erklärt
Die Regel: ein nicht erklärtes Element erscheint nicht Seine Erklärungen, also was erscheint
Die Regel: kein Link unterstrichen, in keinem Zustand Nichts — die Regel wird nicht erklärt
Hinweis:Ein Symbolplatz, kein Kalender. Eine Prosaseite, kein Vorstellungstext. Ein Download-Vertrag, kein Kit.
Hinweis:Kein Link wird unterstrichen, in keinem Zustand. Die Farbe trägt den Hinweis, der Handzeiger bestätigt ihn; eine Unterstreichung beim Überfahren gibt es auf Touchscreens nicht und diente daher nur der Hälfte der Leser.

8Regeln

–Auf Nachfrage informieren. Die drei Zugänge antworten dem, der sie nutzt, und schweigen sonst. Ihr Erscheinen hängt an einer Erklärung des Projekts.

–Eine einzige Veröffentlichung. Das Kit einer Subsite wird aus denselben Seiten ausgeliefert wie ihr Thema. Nichts wird doppelt geführt, kein Bereich abgetrennt.

–Ausführbares Kit. Ein veröffentlichtes Kit wird entpackt und erzeugt die Website. Was nicht läuft, wird nicht veröffentlicht.

–Keine Zusage auf Betreuung. Ein veröffentlichtes Kit muss vollständig und zutreffend sein. Sein Gebrauch durch Dritte bleibt deren Sache.