Checkliste für Design-Reviews
Diese Seite ist eine Checkliste und eine Vorlage für die Prüfung des Entwurfs eines Systems auf Exponential: einer neuen Website, einer Anwendung, einer Migration oder einer großen Erweiterung. Kopieren Sie die Abschnitte in Ihr Entscheidungsprotokoll und beantworten Sie jeden Punkt mit einer Entscheidung und ihrer Quelle.
Inhalt
- Eignung und Umfang
- Inhaltsmodell und Daten
- Laufzeit, Caching und Skalierung
- Sicherheit
- Integration
- Betrieb
- Qualität, Aktualisierungen und Verantwortung
- Eine Vorlage für ein Entscheidungsprotokoll
Eignung und Umfang
- To do: Welches Produkt der Familie, und enthält es, was wir brauchen? (Was Exponential ist)
- To do: Welche Bedürfnisse decken vorhandene Funktionen oder Erweiterungen, und welche brauchen neuen Code? (Exponential bewerten)
- To do: Ist die Lizenz (GNU GPL, Version 2 oder später) mit der Art vereinbar, wie wir unseren Code verbreiten?
Inhaltsmodell und Daten
- To do: Inhaltsklassen, Attribute und Datentypen; welche brauchen eigene Datentypen? (Das Inhaltsmodell für Ingenieure)
- To do: Die Form des Inhaltsbaums, Sektionen und Objektzustände und wie die Berechtigungen ihnen folgen.
- To do: Sprachen: wie viele Inhaltssprachen (höchstens 62), welche Rückfälle, Bedarf an Rechts-nach-links (Internationalisierung und Rechts-nach-links).
- To do: Eigene Tabellen: Persistenzklassen, Schemadateien für jeden Treiber (Schemaänderungen und Migrationen).
- To do: Welche Datenbank, und wird sie in der CI getestet? (Datenbanken: eine wählen und betreiben)
Laufzeit, Caching und Skalierung
- To do: Welcher Anwendungsserver (Anwendungsserver), und ist unser Code in persistenten Workern sicher?
- To do: Welche Caches sind an, wonach sie geschlüsselt sind, wie sie invalidiert werden (Caching-Ebenen für Ingenieure).
- To do: Ein Rechner oder mehrere Knoten; was geteilt wird (Skalierung und Clustering).
- To do: Erwarteter Verkehr, gemessene Seitenkosten und die Reserve (Leistungsmessung und Benchmarks).
- To do: Eine Installation oder mehrere Websites (Installationen mit mehreren Websites).
Sicherheit
- To do: Rollen und Richtlinien für jede Art von Benutzer, schriftlich festgehalten.
- To do: Zwei-Faktor-Anmeldung für das Personal; Sperre; Session-Handler (Authentifizierung, Sessions und Zwei-Faktor-Anmeldung).
- To do: Vertrauenswürdige Proxys, Sicherheits-Header, ein Plan für CSP (HTTP-Sicherheit).
- To do:
ManagedByDeploymentin der Produktion. - To do: Wo Geheimnisse liegen und wer sie wechselt.
Integration
- To do: Welche APIs: REST, ezjscore-Endpunkte, entfernte Dienste; Authentifizierung für jede (API-Design: REST, ezjscore und Headless).
- To do: Hintergrundarbeit: Cronjob-Teile, Inhaltsjobs, expqueue (Konsole, Cronjobs und Hintergrundarbeit).
- To do: E-Mail: Transport, Voreinstellungen und Einwilligung.
Betrieb
- To do: Bereitstellungsverfahren und seine Reihenfolge (Eine Änderung bereitstellen).
- To do: Überwachung, Logs, Audit-Trail, Empfänger von Warnungen (Beobachtbarkeit).
- To do: Sicherungen und eine getestete Wiederherstellung.
- To do: Störungsverfahren und Runbooks (Umgang mit Störungen).
Qualität, Aktualisierungen und Verantwortung
- To do: Tests und CI für unseren eigenen Code (Teststrategie).
- To do: Wie wir Releases von Kernel und Erweiterungen verfolgen und wer die Upgrade-Hinweise liest (Richtlinie zur Rückwärtskompatibilität).
- To do: Composer-Bedingungen und wie wir neu festlegen (Abhängigkeitsverwaltung mit Composer).
- To do: Was wir zurückgeben und ob Mitwirkende die CLA unterzeichnet haben (Upstream beitragen).
- To do: Bekannte Risiken und Schulden, die wir akzeptieren (Mit technischen Schulden umgehen).
Eine Vorlage für ein Entscheidungsprotokoll
| Feld | Inhalt |
|---|---|
| Titel | die Entscheidung in einer Zeile |
| Datum und Status | das Datum; vorgeschlagen, angenommen oder durch ein anderes Protokoll ersetzt |
| Kontext | die Anforderung und die Einschränkung |
| Optionen | zwei oder drei, jede mit ihrer Quellseite |
| Entscheidung | die gewählte Option |
| Folgen | was leichter wird, was schwerer wird, worauf zu achten ist |
| Prüfdatum | wann sie erneut angesehen wird, zum Beispiel nach dem nächsten Release 6.0.x |
Verwandte Seiten
- Checkliste für Code-Reviews
- Ein Exponential-Projekt planen
- Risikomanagement
- Freie Dokumentation: Diese Seite darf unter der GNU FDL 1.3 frei kopiert, übersetzt und verbessert werden.
Werden Sie Exponential-Partner
Partner teilen ihre Informationen, stellen Mittel bereit, geben Beiträge zurück und entwickeln die Produkte mit uns, und so wächst Exponential. Eine Partner-Website und ein Dashboard sind für Mitte 2027 geplant: Werden Sie noch heute Partner, damit wir schneller wachsen und neue Funktionen früher liefern.