Diese Seite enthält die Details eines Projekts für technisches Schreiben, das für die Google-Staffel von Google Docs akzeptiert wurde.
Projektzusammenfassung
- Open-Source-Organisation:
- PostgreSQL
- Technischer Redakteur:
- Lu
- Projektname:
- Einführung
- Projektdauer:
- Standarddauer (3 Monate)
Projektbeschreibung
Aktualisieren Sie die einführende Anleitung, um die Installation und Einrichtung von PostgreSQL für Anfänger zu verbessern. (https://www.postgresql.org/docs/current/tutorial-start.html)
Wandeln Sie das Kapitel zu den Architekturgrundlagen in eine umfassende Einführung in PostgreSQL-Anleitungen um (https://www.postgresql.org/docs/current/tutorial-arch.html). Mögliche Bereiche sind die Client-Server-Architektur, psql als Client-Beispiel, die in dieser Anleitung verwendet werden, die „Cluster“-Terminologie im PostgreSQL-Kontext, Datenbank- im Vergleich zu Betriebssystemnutzern und Eigentum.
Anleitung zur Installation von Updates (https://www.postgresql.org/docs/current/tutorial-install.html)
- Bewerben Sie sowohl Quell- als auch binäre Installationsoptionen. Verweisen Sie auf https://www.postgresql.org/download/. Dort finden Sie eine minimale Installationsanleitung für das Binärprogramm.
- Identifizieren Sie ggf. Lücken in der Installationsanleitung für das Binärprogramm und erweitern Sie entweder die Website oder schließen Sie sie in der Dokumentation.
- Verlassen Sie sich nicht darauf, dass Nutzer das vollständige Kapitel zur Installation der Quelle lesen und es herausfinden: Beschreiben Sie die wichtigsten Schritte, die nach der Installation erforderlich sind, z. B. das Initialisieren des Clusters und das (automatische) Starten des Servers. Geben Sie gegebenenfalls Links zu bestimmten Dokumentationskapiteln mit weiteren Details an.
- Fügen Sie „See-Auch-Links“ zu relevanten Ressourcen hinzu, die auf Standardeinstellungen und Best Practices für ein bestimmtes Betriebssystem eingehen, sofern diese von der Community anerkannt werden.
https://www.postgresql.org/docs/current/tutorial-createdb.html verbessern
- Verzichten Sie nach Möglichkeit auf die Anleitung „Administrator konsultieren“. Bieten Sie umsetzbare Lösungen, die darauf basieren, dass der Nutzer die Anleitung Schritt für Schritt befolgt hat.
https://www.postgresql.org/docs/current/tutorial-accessdb.html verbessern
- Grundlegende Probleme bei der Authentifizierung und einfache Beispiele für pg_hba.conf erklären
Um diesen Dokumentations-Patch zur Verfügung zu stellen, möchte ich das aktuelle Tutorial unter Windows und Ubuntu ausprobieren, in den Foren nach häufigen Einrichtungsproblemen suchen und Mentoren konsultieren, um sicherzustellen, dass ich die Best Practices richtig verstehe und die wichtigsten Konzepte ohne zu komplizierte Erklärung erklärt werden.