57 lines
2.4 KiB
Markdown
57 lines
2.4 KiB
Markdown
# Code of Conduct für Änderungsprotokolle
|
|
|
|
## Allgemeine Richtlinien
|
|
|
|
1. Klarheit und Konsistenz: Alle Einträge müssen klar und konsistent formuliert sein, um Verwirrung zu vermeiden. Verwenden Sie klare, präzise Sprache und folgen Sie den unten aufgeführten Formatierungsrichtlinien.
|
|
2. Abkürzungen und Akronyme: Verwenden Sie standardisierte Abkürzungen für Module und Komponenten. Eine Liste der häufig verwendeten Abkürzungen finden Sie im Abschnitt "Abkürzungen".
|
|
3. Versionsnummern: Geben Sie die Versionsnummern der betroffenen Komponenten klar an. Verwenden Sie die Formatierung Komponente: alte Version -> neue Version.
|
|
4. Kategorien von Änderungen: Gliedern Sie Änderungen in die Kategorien NEW, CHANGED, FIXED, und DOCUMENTATION. Jede Kategorie sollte klar vom Rest des Dokuments abgegrenzt sein.
|
|
|
|
## Struktur und Formatierung
|
|
|
|
### Titel und Metadaten
|
|
|
|
Titel: Verwenden Sie das Format = [Produktname] - Changelog. Beispiel: = TIXstream FX - Changelog.
|
|
Website und Sprache: Geben Sie die Website und die Sprache an. Beispiel:
|
|
|
|
|
|
### Copyright und Versionsinfo
|
|
|
|
- Copyright: Fügen Sie das Copyright-Dokument ein. Beispiel:
|
|
|
|
|
|
- Versionsinfo: Geben Sie die Versionsinformationen ein. Beispiel:
|
|
|
|
|
|
### Änderungsprotokoll
|
|
|
|
- Einführung: Erklären Sie den Zweck des Dokuments und die Bedeutung der einzelnen Einträge. Beispiel:
|
|
|
|
|
|
- Versionseinträge: Jede Version sollte mit der Versionsnummer und dem Datum beginnen. Beispiel:
|
|
|
|
|
|
- Neue Funktionen (NEW): Listen Sie neue Funktionen und Features auf. Verwenden Sie nummerierte Punkte oder Aufzählungen.
|
|
- Änderungen (CHANGED): Dokumentieren Sie wesentliche Änderungen an bestehenden Funktionen oder Systemen.
|
|
- Fehlerbehebungen (FIXED): Beschreiben Sie behobene Fehler und Probleme.
|
|
- Dokumentation (DOCUMENTATION): Erwähnen Sie Änderungen an der Dokumentation oder neuen Dokumenten.
|
|
|
|
### Eintragsformatierung
|
|
|
|
- Klarheit der Beschreibungen: Beschreibungen sollten so präzise wie möglich sein. Vermeiden Sie unnötigen Jargon und halten Sie die Erklärungen einfach.
|
|
- Verweise auf Tickets: Falls zutreffend, verwenden Sie Ticket-IDs zur Referenz. Beispiel: (_#12345_).
|
|
- Modul- und Komponentennamen: Verwenden Sie die offiziellen Namen und Abkürzungen für Komponenten. Beispiel:
|
|
|
|
|
|
### Abkürzungen
|
|
|
|
Use standard abbreviations for components:
|
|
|
|
- AM: Access Manager
|
|
- FXweb: FX Web Tools
|
|
- TCC: TIXEL Control Center
|
|
- TXEC: TIXstream Express Client
|
|
- TXEJM: TIXstream Express Job Manager
|
|
- TXSFX: TIXstream FX
|
|
- TXY: TIXway
|
|
|