Beiträge zur öffentlichen technischen Dokumentation über GitHub

Die technische Dokumentation wird ständig weiterentwickelt und jeder kann dazu beitragen, sie zu verbessern. Sie benötigen keine komplexen lokalen Entwicklungsumgebungen oder Git-Kommandozeilenkenntnisse, um einen sinnvollen Einfluss auf öffentliche technische Ressourcen zu haben. Dieser reine Textkurs führt Sie durch den gesamten Prozess des Beitragens zur öffentlichen Dokumentation direkt von Ihrem Webbrowser aus. Sie lernen, wie Sie durch die Repository-Strukturen navigieren, Änderungen vornehmen und Ihre Änderungen zur Überprüfung einreichen. Was Sie lernen werden: - Verstehen Sie die Kernkonzepte von Workflows für die öffentliche Dokumentation und Open-Source-Beiträgen - Navigieren Sie durch Dokumentations-Repositorys und suchen Sie Dateien mithilfe der browserbasierten GitHub-Oberfläche - Bearbeiten Sie Dokumentationsinhalte selbstbewusst mit Markdown-Formatierung und Syntax-Best Practices - Erstellen und verwalten Sie Pull-Anfragen vollständig in Ihrem Webbrowser - Überprüfen Sie Ihre Änderungen, um sicherzustellen, dass Formatierung, Stilrichtlinien und Links den Projektstandards entsprechen - Arbeiten Sie mit Betreuern zusammen, indem Sie auf Feedback zu Ihren eingereichten Entwürfen antworten Wir beginnen mit der grundlegenden Terminologie der Versionskontrolle und des Dokumentationshostings. Anschließend gehen Sie durch praktische, schrittweise schriftliche Übungen, die Sie durch das Auffinden eines Problems, das Durchführen einer Bearbeitung im Browser und das Einreichen eines Pull-Requests führen. Dieser Kurs wurde für absolute Anfänger, technische Autoren und Entwickler entwickelt, die ohne Installation komplexer Tools zur Dokumentation beitragen möchten. Beginnen Sie noch heute mit dem Lesen, um Ihren ersten Dokumentationsbeitrag zu leisten.