Dokumentations Arbeitsgruppe
From Joomla! Documentation
Die Dokumentations-Arbeitsgruppe
Die Dokumentations-Arbeitsgruppe ist Teil der Produktions-Abteilung. Sie ist für die Erstellung und Wartung aller offiziellen Joomla!-Dokumentationen für Endbenutzer, Administratoren und Dritthersteller-Entwickler genauso wie für die Hilfeseiten im Backend verantwortlich.
Dokumentation - Weitere Teams
Dokumentation Hilfeseiten-Team
Das Dokumentation Hilfeseiten-Team ist für Wartung und Updates der Hilfeseiten der Joomla!-Veröffentlichungen verantwortlich.
Dokumentation Übersetzungs-Team
Die offizielle Dokumentationssprache ist britisches Englisch. Übersetzungen der offiziellen Dokumentation in andere Sprachen fallen in die Zuständigkeit des Dokumentation Übersetzungs-Teams (JDT).
en-GB User Interface Text-Arbeitsgruppe
Das Joomla! en-GB User Interface Text Team ist für die Erstellung und Wartung der offiziellen Stil-Richtlinien der en-GB-Strings wie für deren durchgehende Konsistenz in Joomla! verantwortlich.
Joomla! Dokumentations Wiki
Der Großteil der Dokumentationsarbeit dreht sich um dieses Wiki.
- Bitte Docs Wiki Roadmap für einen kompletten Arbeitsüberblick besuchen.
- Wer keine Erfahrungen mit MediaWiki hat, findet unter Übersicht Information zur Wiki-Software.
- Einige Gepflogenheiten, damit das Wiki verwendbar bleibt:
- Ebenfalls hilfreich:
- Gewünschte, aber noch Leere Seiten
- Keksdose: Eine Liste von Seiten, die für die Fertigstellung kleine, gut definierte Arbeitsschritte benötigen
- Beiträge, die eine Überprüfung benötigen
- Beiträge, die Informationen benötigen: Jeder Besucher kann bestimmte Details wissen
- Portalseiten: Sie basieren auf Schlüsselwörtern, die in Suchmaschinen zur Dokumentationssuche eingegeben wurden.
- Begriffserklärungen dem Glossar hinzufügen, aber nicht mit [[Category:Glossary]]. Weitere Informationen unter Glossary.
Interne Referenzen
- Liste der local wiki templates, die in den Wikiseiten verwendbar sind. Templates vermeiden Wiederholungen und sind die Basis modularer Dokumentation.
- Liste der local wiki extensions, die im Wiki installiert sind. Sie fügen Funktionen wie syntax highlighting und link search hinzu.
- Liste der local interwiki links, die im Wiki verfügbar sind. Das sind Kürzel zum Erstellen von Links zu anderen Websites wie das Joomla-Forum, Hilfeseiten und Issue Tracker; genauso Links zu PHP-Handbuch und Wikipedia.
Alle Dokumentations-Websites
Die Dokumentations-Arbeitsgruppe wartet diese Websites:
api.joomla.org
Die gesamte Site wird automatisch über das phpDocumentor-Paket durch Analyse des Joomla!-Quellcodes und Gebrauch spezieller Kommentarformatierung im Quellcode selbst erstellt. Es ist ein unschätzbares Werkzeug für Joomla!-Entwickler.
docs.joomla.org
Das Konzept hinter docs.joomla.org ist, dass es die zentrale Ressource der Entwicklung einzeln erstellter, Dokumentationsmodule des Joomla!-Projektes ist. Die Idee ist, etwas einmal zu schreiben und wiederzuverwenden, vergleichbar moderner OOP-Softwareentwicklung. Mit der Errichtung der zentralen Datenbank von Dokument-"Chunks" wird der größte Nutzen aus den Ergebnissen einer begrenzten Zahl an Autoren gewonnen, die gleichzeitig "flexible" Dokumente ergeben, da eine Änderung rasch alle Dokumente betrifft.
Mehr Informationen unter Modular documentation.
Für diejenigen, die nicht sehr erfahren in der Bildbearbeitung sind und vielleicht die Qualität ihrer Screenshots verbessern wollen, ist das Tutorial Screenshots aufnehmen und verbessern zu empfehlen.
Die Joomla! Hilfeseiten werden in diesem Wiki erstellt und werden im Backend jeder Joomla! Website von hier aus angezeigt.
Weitere Öffentliche Ressourcen
- Public discussion forum
- Documentation Working Group mailing list
- Developer documentation mailing list
- The Documentation Working Group im Joomla!-Freiwilligenportal™
- The Documentation Translation Team im Joomla!-Freiwilligenportal™
- Documentation Translators
- MediaWiki setup notes
- Dokumentor-Profil des Wiki.