Demo

Probiere ClanSphere aus und teste daran herum. Demo


Antworten: 9
Seite [1]
rocco


Going for pro




Herkunft: Wiesbaden
Beiträge: 444
# Thema - 18.03.2007 um 12:31 Uhr
Guten Morgen zusammen!

Da wir (sowohl das ClanSphere-Team als auch wir von Webmedia Solutions) in letzter Zeit vermehrt auf die Dokumentation angesprochen wurden, habe ich mal den Stein ins Rollen gebracht. Da noch nicht viel zur Doku gesagt wurde, betrachte ich diese Gelegenheit als eine Ehre, dass ich mit diesem Thread die Art und Weise der Dokumentation zum ClanSphere CMS vorstellen darf.

Jeder von Euch kennt Wikipedia. In meinen Augen das sinnvollste und nützlichste Internetprojekt, seitdem es das WWW gibt. Diese Software bzw. das Script nennt sich Wikimedia und ist Open Source. Wir haben uns für die Dokumentation dieses Script zu Nutze gemacht, um Euch eine nahezu perfekte Dokumentierung bieten zu können.

Nun zum eigentlichen Thread:
In diesem Thread wollen wir mit Euch zusammen Begriffe sammeln, die erläutert werden müssen. Wir Ihr wisst oder mit Sicherheit nachvollziehen könnt, fällt einem als Entwickler oder als "Zuarbeiter" in der Regel nicht viel ein, was einer Erläuterung bedarf, da man es ja kann. ,)
Also bitten wir Euch, dass Ihr in diesem Thread Schlagworte nennt, die erklärt werden müssen/sollten. Selbstverständlich könnt/sollt Ihr auch mehrere Begriffe zu einem Thema nennen, wie z.B. Copyright, About, Lizenz; diese würden dann mit der REDIRECT-Fukntion auf die Seite "About" weitergeleitet werden.

Ich fange einfach mal mit der Liste an:

- update(s)
- changelog
- support
- lizenz
- modulerstellung
- funktionen
- sprachen
- themes / templates

Der übersichthalber bitten wir Euch, dass Ihr Eure Beiträge editiert, falls Euch neue Sachen einfallen. Wir werden nach Eintragung eines Begriffes den entsprechenden Begriff in dem Beitrag durchstreichen!

Achso, hier schonmal der Link zur Dokumentation, ein bischen steht natürlich schon drin. ,)

Hauptseite - ClanSphere Wiki

Danke fürs Zuhören und viel Spass mit dem Wiki!


------------------
WS | rocco
Projektleiter Webmedia Solutions
[ www.webmedia-solutions.de ]
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FSK 12 heißt: Der Held kriegt das Mädchen
FSK 16 heißt: Der Böse kriegt das Mädchen
FSK 18 heißt: Jeder kriegt das Mädchen
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Inaktiv
worstbull


King for a day




Herkunft: Schweiggers
Beiträge: 222
# Antwort: 1 - 18.03.2007 um 18:50 Uhr
A.)
- hilfe
- installation
- faq
- nachrichten
- board
- abcode
- thread
- addons
- multimedia
- zugriff
- verwaltung
- administration
- anpassung
- designanpassung
- login
- join us
- fight us
- registrieren
- moderation
- webmaster
- downloads
- links
- about
- news
- artikel
- imprint
- svn
- dokumentation
- clansphere.net
- homepage
- anpassung der homepage
- meldungen
- bugtracker
- eintrag erstellen
- banner
- ajax
- css anpassen
- demo
- wars
- php
- board-features
- spiele
- clans
- mitglieder
- konvertieren (join us, fight us)
- chmod
- ClanSphere Doku:Urheberrecht

B.) Kann ich mitmachen??


------------------


Zuletzt editiert von worstbull am 20.03.2007 um 08:03 Uhr (1x Editiert)
Inaktiv
|
rocco
Thread-Ersteller


Going for pro




Herkunft: Wiesbaden
Beiträge: 444
# Antwort: 2 - 19.03.2007 um 08:04 Uhr
A.) sehr schön! genau so stellen wir uns das vor!

B.) Am besten mal direkt mit h0n1g kurzschließen. von mir aus gerne...


------------------
WS | rocco
Projektleiter Webmedia Solutions
[ www.webmedia-solutions.de ]
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FSK 12 heißt: Der Held kriegt das Mädchen
FSK 16 heißt: Der Böse kriegt das Mädchen
FSK 18 heißt: Jeder kriegt das Mädchen
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Inaktiv
|
jojo


Rock the board





Beiträge: 60
# Antwort: 3 - 19.03.2007 um 11:01 Uhr
- teams
- cups
- events, kalender
- navlist
- kategorien
- replays
- system
- statische Seiten
- ranking


Inaktiv
|
Mr.AndersoN


Going for pro




Herkunft: Dresden
Beiträge: 529
# Antwort: 4 - 19.03.2007 um 14:20 Uhr
1. alle Module nach gleichem Schema erklären:
1.1 Kurze Beschreibung
1.2 Funktionen (welche Informationen werden wie und wo dargestellt)
1.3 Administrationserklärung (Wie kann man Informationen erstellen, welche Besonderheiten gibt es)
1.4 Welche Abhängigkeiten bestehen zu anderen Modulen und welche SQL-Tabellen werden von dem Modul verwendet

Beispiel für 1.3:
  • News: Die Option des anheften oder die Möglichkeit, die News vorerst nicht publik zu machen


2., 3., ... folgt


------------------
ClanSphere - professional clan care starts here






Zuletzt editiert von Mr.AndersoN am 19.03.2007 um 14:20 Uhr (1x Editiert)
Inaktiv
|
worstbull


King for a day




Herkunft: Schweiggers
Beiträge: 222
# Antwort: 5 - 20.03.2007 um 17:17 Uhr
Die Anwendung eines einheitlichen Schemas auf die Artikel selber ist mit Vorsicht zu genießen.

Da, wie man schon bei Wikipedia sieht, jeder Artikel seine ganz eigenen Besonderheiten und Eigenschaften hat.


Die angesprochenen Punkte realisieren wir lieber durch Verwendung eines jeweils eigenen Artikels, damit die Artikel A) nicht so lang werden und B) das WIKI nicht zu einem Entwickler-Tool verkommt
sondern wirklich ein gutes Hilfe-Werkzeug wird, das man zB auch durch "?"<- Links in die Module einbauen kann. Mit jeweils einem kurzen Absatz zu einem Hilfebeitrag und Links zu den diversen Funktionen und weiteren Möglichkeiten.

Natürlich muss auch für den Entwickler bzw erweiterten, fortgeschrittenen Benutzer Information vorhanden sein, aber diese lässt sich ganz leicht ausgliedern, wenn man bei den Links zum Artikel ganz unten auf den Doku-Seiten schreibt:
-'Verwendete SQL Tabellen des Moduls XY'
-'Vorgehensweise für Anpassungen am Modul XY'
-'Geschichte des Moduls XY'
-'Abhängigkeiten zu anderen Modulen bzw weitere Information für Entwickler am Modul XY'
-'Anmerkungen des Verfassers von Modul XY'

Sowie eine Ausgliederung der Funktionen (manche Module haben Dutzende, wenn nicht hundert und mehr Funktionen) in Form einer Liste wie wir es schon vom bereits bestehenden Artikel "Clansphere 2007" kennen, mit Links und einer ganz kurzen Beschreibung:
-Funktionsliste des Moduls XY:
LINK zu BEARBEITEN-Funktion .... Die Bearbeiten-Funktion erlaubt dies und das
LINK zu VORSCHAU-Funktion .... Die Vorschau-Funktion erlaubt dies und das
LINK zu NOCHMAL-Funktion .... Die Nochmal-Funktion....


Und das am besten in einer übersichtlichen Tabelle oder Liste!



Statt eines Schemas (lässt sich wie gesagt nicht auf eine Doku anwenden, da jeder Artikel seine eigenen Merkmale hat, deswegen gefällt mir der Begriff 'Richtlinien' besser) würde ich folgendes vorschlagen, als Richtlinie:

Auf jeden Fall ein Inhaltsverzeichnis, falls der Text grösser als eine halbe Bildschirmseite wird (ungefähr).
Nach Möglichkeit bei längeren Artikeln eine kleine Box mit Angaben zum Thema ganz oben rechts auf der Seite, so wie hier: http://de.wikipedia.org/wiki/Php

Gliederung des Textes in Absätze mit Überschriften, die im Inhaltsverzeichnis intern verlinkt sind.

Als weiteres Format-Schema folgende Eigenschaften: Eine Überschrift, ein Zeitstempel vom Verfasser, viele Formatoptionen anwenden, italic, fett, unterstrichen.
Vor allem Gliederungselemente wie Listen massiv einsetzen.
Viele Hyperlinks, Quellenangaben, Links zu den eigentlichen Funktionen des Moduls samt kurzer Darstellung deren Funktion in nur einem stichworthaften Satz;
Viele Bilder mit hervorgehobener Angabe des aktuellen Funktionsteils. Zum Beispiel durch einen roten Rahmen um einen Button oder Inputfeld das im Text besprochen wird.
Weitere Multimediaelemente, zum Beispiel Flash-Tutorials verwenden oder auch Tabellen, Schemadarstellungen, Diagramme.
Optional ein Inhaltsverzeichnis.



Ganz grob soll die Funktion eines Moduls erläutert werden:


1. Den Namen des Moduls und eventuell welche Seite es betrifft
(Inhaltsverzeichnis des Artikels wenn er die Grösse eines Absatzes überschreitet)
2. Die Beschreibung in einem kurzen Absatz, was dieses Modul macht.
3. Eine Zusammenfassung der Funktionen im Modul, so wie es bei "Clansphere 2007" schon steht, mit einer Kurzbeschreibung neben einem Link zur eigentlichen Funktion, so dass man diese Funktions-Beschreibung mehrmals verwenden kann - einfach durch das Setzen des Links!
4. Die Verwendung des Moduls (Bilder verwenden, aber immer im selben Design, durch Verwendung eines einheitlichen Templates. Auf den Bildern hervorheben wo man das Modul bedienen kann, welcher Link gerade beschrieben wird, oder Button bzw auch welche Tabelle, Liste oder Funktions-Leiste)

5. Links:
a. Links samt Kurzbeschreibung zu diversen Sonderfunktionen, zB der Möglichkeit, Funktionen des Moduls per Tag {users:navlogin} einbauen zu können.
b. Externe Links (Zu anderen Webseiten, Tutorials im CS-Board)
c. Frühere Versionen: Links zur Dokumentation von früheren Versionen, falls der Artikel upgedated wird

6. Verfasser des Moduls
7. Quellen (Von wem habt ihr Informationen zum Modul, gibt es bereits Tutorials dazu)


MF

Edit- Anmerkung:

Kategorien sollten unbedingt erstellt und verwendet werden:
Hier gleich mal meine Kategorien-Liste - fällt euch dazu noch was ein?
Ich würde diese sehr kurz halten, wie hier mit nur fünf Kategorien in die alle Artikel passen und dafür Subkategorien einführen bzw verwenden:
-Allgemeines zum Clansphere CMS
-Installation
-Entwicklung (und Datenbank)
-Module (Subkategorie: Modul-Funktionen)
-Templating (und weitere Anpassung)

MF


------------------


Zuletzt editiert von worstbull am 20.03.2007 um 17:35 Uhr (2x Editiert)
Inaktiv
|
rocco
Thread-Ersteller


Going for pro




Herkunft: Wiesbaden
Beiträge: 444
# Antwort: 6 - 20.03.2007 um 17:35 Uhr
stopstopstop

ich weiß, dass du ehrgeizig und fleißig bist, worstbull! aber lass uns das bitte alles erstmal in ruhe "intern" diskutieren und auch abstimmen. und weiterhin gehören "abstimmungssachen" oder verfahrensweisen nicht hier rein.

Hier bitte wirklich nur BEGRIFFE rein, die erläutert werden sollen! DAS IST KEIN DISKUSSIONSTHREAD!!!!!

* update *
wir werden uns ein internes board mit pw machen. ich sag h0n1g bescheid. LESEN SVEN!


------------------
WS | rocco
Projektleiter Webmedia Solutions
[ www.webmedia-solutions.de ]
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FSK 12 heißt: Der Held kriegt das Mädchen
FSK 16 heißt: Der Böse kriegt das Mädchen
FSK 18 heißt: Jeder kriegt das Mädchen
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Zuletzt editiert von rocco am 20.03.2007 um 18:27 Uhr (2x Editiert)
Inaktiv
|
worstbull


King for a day




Herkunft: Schweiggers
Beiträge: 222
# Antwort: 7 - 20.03.2007 um 18:12 Uhr
Bin ganz deiner Meinung... Gibt es schon einen Diskussionsthread zu CS Wiki oder gar ein Board??

//edit: Sehr gut, danke!

MFG MF


------------------


Zuletzt editiert von worstbull am 21.03.2007 um 01:09 Uhr (1x Editiert)
Inaktiv
|
TheSorcerer


Beginner



Herkunft: Gelnhausen
Beiträge: 16
# Antwort: 8 - 12.05.2010 um 16:29 Uhr
Nur so am Rande: die Software, die die Wikipedia benutzt nennt sich nicht Wikimedia sondern MediaWiki - Wikimedia ist die Stiftung, welche Wikipedia betreibt.


Zuletzt editiert von TheSorcerer am 12.05.2010 um 16:29 Uhr (1x Editiert)
Inaktiv
|
sgraewe ClanSphere Team

Supporter
Supporter




Beiträge: 6115
# Antwort: 9 - 12.05.2010 um 16:30 Uhr
3 Jahre...


Offline
|

Dieses Thema wurde von sgraewe ClanSphere Team PM geschlossen.

Antworten: 9
Seite [1]