Diese Seite enthält die Details zu einem Projekt für technisches Schreiben, das für die Google-Produktsaison 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 „Architectural Fundamentals“ in eine umfassende Einführung in PostgreSQL-Anleitungen um (https://www.postgresql.org/docs/current/tutorial-arch.html). Mögliche Aspekte, die erweitert werden könnten, sind die Client-Server-Architektur, psql als Client-Beispiel, das in dieser Anleitung verwendet werden soll, „Cluster“-Terminologie im PostgreSQL-Kontext, Datenbank- im Vergleich zu Betriebssystemnutzern und Eigentum.
Anleitung zum Aktualisieren der Installation: https://www.postgresql.org/docs/current/tutorial-install.html
- Bewerben Sie sowohl Quell- als auch binäre Installationsoptionen. Fügen Sie den Verweis auf https://www.postgresql.org/download/ hinzu. 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 die Nutzer das vollständige Kapitel zur Quellinstallation 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. Gib gegebenenfalls Links zu bestimmten Dokumentationskapitel an, um weitere Informationen zu erhalten.
- Füge auch 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 zur Kontaktaufnahme mit dem Administrator. Bieten Sie umsetzbare Lösungen, die darauf basieren, dass der Nutzer die Anleitung Schritt für Schritt ausgeführt 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 bereitzustellen, möchte ich das aktuelle Tutorial unter Windows und Ubuntu ausprobieren, in Foren nach häufigen Einrichtungsproblemen suchen und Mentoren konsultieren, um sicherzustellen, dass ich die Best Practices richtig bekomme und die wichtigsten Konzepte ohne übermäßige Vereinfachung erklärt werden.