PEP 732 – Das Redaktionskomitee der Python-Dokumentation
- Autor:
- Joanna Jablonski
- Sponsor:
- Mariatta Wijaya
- Discussions-To:
- Discourse thread
- Status:
- Aktiv
- Typ:
- Prozess
- Thema:
- Governance
- Erstellt:
- 14-Okt-2023
- Post-History:
- 20-Okt-2023
- Resolution:
- Discourse-Nachricht
Inhaltsverzeichnis
Zusammenfassung
Dieser PEP
- Etabliert das Redaktionskomitee der Python-Dokumentation
- Schlägt vor, wie das Redaktionskomitee arbeiten wird
Motivation
Der Steering Council genehmigte im März 2021 die Schaffung einer Documentation Working Group (Arbeitsgruppe für Dokumentation), um die Richtung für die Dokumentation festzulegen. Diese Gruppe wird nun Redaktionskomitee genannt, um sie von der Documentation Working Group zu unterscheiden, die inzwischen zur Konzentration auf taktischere Arbeiten geschaffen wurde.
Der Zweck der Python-Dokumentation ist es, die gegenwärtigen und zukünftigen Endbenutzer von Python zu bedienen. Daher arbeiten die Kernentwicklungsgemeinschaft und die breitere Gemeinschaft der Mitwirkenden an der Python-Dokumentation zusammen, um dies zu erreichen.
Spezifikation
Mandat
Das Redaktionskomitee wird
- Sicherstellen, dass Prozesse zur Aufrechterhaltung und Verbesserung der Qualität der Python-Dokumentation vorhanden sind
- Die Python-Dokumentation als Gemeinschaftsressource fördern, um aktuelle und zukünftige Benutzer zu bedienen
- Im Einklang mit der Mission der Python Software Foundation handeln, die darin besteht, die Programmiersprache Python voranzutreiben und das Wachstum einer vielfältigen und internationalen Gemeinschaft von Python-Programmierern zu unterstützen und zu fördern
- Sicherstellen, dass die Mitarbeit an der Dokumentation zugänglich, inklusiv und nachhaltig ist
- Angemessene Entscheidungsprozesse für Dokumentationsinhalte etablieren
- Versuchen, Konsens unter den Mitwirkenden zu erzielen, bevor Entscheidungen getroffen werden
- Der endgültige Schiedsrichter für Entscheidungen über Dokumentationsinhalte sein
Verantwortlichkeiten
Das Komitee hat die Befugnis, Entscheidungen über die Python-Dokumentation zu treffen, wie unten beschrieben. Es kann zum Beispiel
- Die übergeordnete Strategie für die Python-Dokumentation festlegen
- Die vorgesehene Struktur für die Dokumentation festlegen
- Stil- und redaktionelle Entscheidungen für sowohl das Schreiben als auch das Design treffen
- Dokumentations-Governance handhaben (z. B. Delegation von Entscheidungen an Fachexperten, Beilegung von Meinungsverschiedenheiten, Entscheidungen).
Umfang
Das Redaktionskomitee beaufsichtigt die Inhalte und Strategien für Folgendes
| Im Umfang | Nicht im Umfang |
|---|---|
| CPython-Dokumentation (docs.python.org) | Code-Kommentare im CPython-Codebestand |
| CPython devguide (devguide.python.org) | CPython Docstrings |
| Übersetzungen der CPython-Dokumentation | PEPs (peps.python.org) |
| PyPA-Dokumentation | |
| www.python.org | |
| Das Python-Wiki (wiki.python.org) |
Zusammensetzung
Das Redaktionskomitee der Python-Dokumentation besteht aus fünf Mitgliedern.
Mitglieder des Redaktionskomitees
Die anfänglichen Mitglieder des Redaktionskomitees sind
- Mariatta Wijaya
- Ned Batchelder
- Joanna Jablonski
- Guido van Rossum
- Carol Willing
Qualifikationen der Mitglieder des Redaktionskomitees
Die Mitglieder des Redaktionskomitees sollten haben
- Ein gutes Verständnis der Philosophie des Python-Projekts
- Erfahrung in der Python-Ausbildung und der entwicklerorientierten Dokumentation
- Eine solide Erfolgsbilanz als konstruktiv und hilfsbereit
- Eine Geschichte bedeutender Beiträge zu Python
- Die Bereitschaft, Zeit für die Verbesserung der Python-Dokumentation aufzuwenden
Mitglieder des Redaktionskomitees sollten Erfahrung in den Bereichen Bildung, Kommunikation, technisches Schreiben, Python-Dokumentation, Barrierefreiheit, Übersetzung oder Community-Management haben.
Amtszeit
Die Mitglieder des Redaktionskomitees werden auf unbestimmte Zeit berufen, obwohl im Allgemeinen erwartet wird, dass sich die Zusammensetzung des Redaktionskomitees jedes Jahr ändert. Die Mitglieder des Redaktionskomitees werden jährlich bestätigen, ob sie weiterhin als Vorstandsmitglied tätig sein möchten. Mitglieder können jederzeit zurücktreten.
Wenn ein Vorstandsmitglied den Kontakt verliert und einen Monat oder länger nicht erreichbar ist, kann der Rest des Vorstands abstimmen, es zu ersetzen.
Änderungen der Größe des Redaktionskomitees
Jährlich nach jeder wichtigen Python-Veröffentlichung wird das Redaktionskomitee prüfen, ob die Größe des Komitees geändert werden sollte. Dies bietet Flexibilität, wenn sich die Bedürfnisse der Dokumentationsgemeinschaft im Laufe der Zeit ändern. Eine einfache Mehrheit ist erforderlich, um eine Entscheidung zur Erhöhung der Größe des Komitees zu treffen, wobei das Quorum 80 % des aktuellen Komitees beträgt.
Als sponsoring Organisation des Redaktionskomitees der Dokumentation kann der Steering Council die Anzahl der Mitglieder des Komitees jederzeit ändern, einschließlich der Ernennung neuer Mitglieder oder der Entlassung bestehender Mitglieder.
Vakanzen
Wenn aus irgendeinem Grund eine Vakanz im Komitee besteht, wird das Redaktionskomitee der Dokumentation öffentlich einen Aufruf für potenzielle Komiteemitglieder bekannt geben. Potenzielle Komiteemitglieder würden ein kurzes Dokument einreichen, das ihre Qualifikationen und ihre Motivation zur Mitarbeit darlegt. Die amtierenden Mitglieder des Redaktionskomitees wählen neue Komiteemitglieder mit einfacher Mehrheit, wobei das Quorum 80 % des aktuellen Komitees beträgt.
Änderungen
Dieser PEP dient als Charta für das Redaktionskomitee der Docs. Änderungen an seiner Funktionsweise können entweder durch einen neuen PEP oder durch eine Änderung dieses PEP vorgenommen werden. In beiden Fällen würde die Änderung vom Steering Council nach Diskussion in der Gemeinschaft beschlossen.
PEP-Akzeptanz
PEP 732 wurde am 11. Dezember 2023 vom Python Steering Council akzeptiert.
Der Steering Council merkte an, dass er zwar der im PEP dargelegten Geltungsbereich nicht widerspricht, es aber wahrscheinlich sinnvoll wäre, wenn das Redaktionskomitee erwägt, den Geltungsbereich auf Docstrings in der Standardbibliothek auszuweiten, sobald das Komitee ausreichend etabliert ist und die höheren Prioritäten erledigt sind.
Kontakt
Um das Redaktionskomitee um eine Entscheidung zu bitten, können Community-Mitglieder ein Issue im Repository python/editorial-board/ eröffnen.
Urheberrecht
Dieses Dokument wird in die Public Domain oder unter die CC0-1.0-Universal-Lizenz gestellt, je nachdem, welche Lizenz permissiver ist.
Quelle: https://github.com/python/peps/blob/main/peps/pep-0732.rst
Zuletzt geändert: 2025-02-01 07:28:42 GMT