Joomla! Documentation™

Als Dokumentor hat man die wenig beneidenswerte Aufgabe, Material für eine große Bandbreite an Lesern, vom Einsteiger bis zum erfahrenen, professionellen Entwickler, zu schreiben. Man muß verschiedenen Werkzeuge (wie dieses Wiki) nutzen können sowie Richtlinien und andere Meta-Dokumente lesen. Die Dokumente werden mit der Zeit wahrscheinlich überarbeitet werden müssen.

Allgemein

Die offizielle Projektsprache ist Britisches Englisch (en-GB). Es gibt die Tendenz, die amerikanische Schreibweise zu verwenden. Diese Textstellen dürfen gerne korrigiert werden, wo immer sie vorkommen.

Dieses Material ist für die Dokumentation in allen Bereichen des Joomla!-Projektes wichtig.

• Joomla! en-GB User Interface Text Guidelines.
• Words to Watch (W2W)

Dokumentation 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:
  • Richtlinien zur Bildbenennung
  • Seiten mit Joomla!-Versionsnummern etikettieren
• 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.

Hilfe Seiten

Die Dokumentations Arbeitsgruppe ist für Schreiben und Wartung der offiziellen Hilfeseiten verantwortlich. Seit der Version 1.6 von Joomla! werden die Hilfeseiten auf dieser Website gehostet.

• Siehe Hilfe-Seiten.
• Setting up a local help server