Wie gehe ich mit welcher Dokumentation vor?

Hier finden sich Fragen und Ergänzung zur Dokumentation. // All questions and discussions about the documentation.
Antworten
dirtdevel
Beiträge: 28
Registriert: 26.12.2011, 23:51:51

Wie gehe ich mit welcher Dokumentation vor?

Beitrag von dirtdevel » 28.12.2011, 18:02:54

Hallo ABF-Community,

Ich habe großes Interesse und Neugier an dem Erlernen des APF Frameworks.

Was mich bisher doch ziemlich aufhält ist ein eigentlich ein beschämend geringer Punkt:
Man weiß nicht, wann man wie mit welcher Dokumentation anfängt ^^:

1. Tutorials
2. Komponenten-Dokumentation
3. Artikel
4. API-Dokumentation
5. Knowledgebase
6. Forum
7. Demopack
8. Wiki

Es fehlt also ganz und gar nicht an genügend Anleitungen - das ist gar nicht das Problem!

Allerdings ist man von der Auswahl überschlagen, man hat ACHT ver. Dokumentationsquellen, welche sich gegenseitig dabei nur ergänzen und der dumme User weiß nicht mit was er anfangen soll!

Auswahl überfordert einen und in diesem Fall ist es als destruktiv zu bezeichnen.

Vielleicht könnt ihr in den Dokumentationsbereich ein Inhaltsverzeichnis reinsetzen, wo man Schritt für Schritt alles abarbeiten kann.
Ansich würde ich es auch machen, wenn ich den Durchblick hätte...

Das soll keineswegs böse gemeint sein und an sich passiert mir das auch öfters, dass man lieber mit irgendwas von vorne anfängt anstatt eine Sache zu ende zu bringen. Das Ergebnis sind sehr viele Einzelteile...
Vielleicht kann mir jemand auch einen Glossar bzgl. der Dokus ins Forum schreiben.
Mir und vielen Anderen würde das aufjedenfall enorm helfen.

Mit freundlichen Grüßen,
dirtdevel

Benutzeravatar
dr.e.
Administrator
Beiträge: 4527
Registriert: 04.11.2007, 16:13:53

Re: Wie gehe ich mit welcher Dokumentation vor?

Beitrag von dr.e. » 28.12.2011, 19:23:34

Hallo dirtdevil,

für den Einstieg wird unter http://adventure-php-framework.org/Seit ... umentation das Tutorial http://adventure-php-framework.org/Seit ... e-Schritte genannt. Von dort aus kannst du dich durchhangeln. Nächste Schritte könnten dann http://adventure-php-framework.org/Seit ... e-Schritte und http://adventure-php-framework.org/Seit ... -erstellen oder die Artikel-Serie von Tobi unter http://gagugaming.de/category/apf/ sein.
1. Tutorials
Die Tutorials auf http://adventure-php-framework.org/Seite/071-Tutorials und http://wiki.adventure-php-framework.org/Tutorials sind dazu da, eine Einführung in die dort aufgeführtem Themen und die Umsetzung mit dem APF zu geben. Sie bieten einen Einstieg in das APF, führen jedoch auch komplexere Themen aus (z.B. Einstieg in den GORM).
2. Komponenten-Dokumentation
Die Seiten unterhalb dieses Punktes beinhalten die Dokumentation zu allen mit dem APF ausgelieferten Komponenten/Modulen/Tools - kurz aller Bestandteile.
3. Artikel
Im Rahmen von Artikel beschäftigen sich die unterschiedlichen Autoren mit konkreten Themen wie das Setup des UMGT-Moduls, Performance-Messungen oder der Migration einer APF-Version auf die nächste.
4. API-Dokumentation
Hier findest du eine mit doxygen generierte API-Dokumentation. Diese ist dazu gedacht, Methoden und Klassen im Rahmen der Implementierung eines Projektes oder einer APF-Funktion (falls du ein Contributor bist) nachzulesen. Sie gibt einen Überblick über die besetehenden Packages und Klassen sowie deren Funktion.
5. Knowledgebase
8. Wiki
Das Wiki (=KB) beinhaltet Artikel von Benutzern des APF und dient als Ergänzung der apf.org.
6. Forum
Nutzt du gerade und dir wird geholfen, wenn du Fragen hast. :)
7. Demopack
Die apf-demopack-*-Dateien (=Sandbox) beinhalten eine lauffähige Webseite, die einerseits als Demo der APF-Funktionalität gedacht sind, andererseits eine fertige Entwicklungsumgebung darstellen, mir der du ein Projekt starten oder ausgewählte Module laufen lassen oder testen kannst. Ich persönlich nutze die Sandbox zur Entwicklung der APF-Komponenten, da ich mir sonst erst noch eine Umgebung zusammenbauen muss.
Vielleicht könnt ihr in den Dokumentationsbereich ein Inhaltsverzeichnis reinsetzen, wo man Schritt für Schritt alles abarbeiten kann.
Ansich würde ich es auch machen, wenn ich den Durchblick hätte...
Hierzu ist die Seite http://adventure-php-framework.org/Seit ... umentation gedacht. Diese bietet einen ersten Überblick, anschließend zeigen dir z.B. http://adventure-php-framework.org/Seit ... umentation an, was es alles gibt. Im Prinzip ist schon alles da. :)

Hoffe, das hilft dir weiter.
Viele Grüße,
Christian

dirtdevel
Beiträge: 28
Registriert: 26.12.2011, 23:51:51

Re: Wie gehe ich mit welcher Dokumentation vor?

Beitrag von dirtdevel » 28.12.2011, 23:04:07

Danke, das hilft mir schon ;)
Ich geb zu, ich habe mich etwas idiotisch angestellt ^^

Ich will mal ein (für mich persönlich) gelungenes Beispiel nennen. Man wird von den Basics bis zu den Fortgeschrittenen Themen geleitet und hat einen recht einfachen Einstieg.

Dazu fällt mir das FreeBSD Handbook ein: http://www.freebsd.org/doc/en_US.ISO885 ... /handbook/
So etwas in der Art würde sich jeder Anfänger fürs APF wünschen.

Ansonsten, vielen Dank für die Arbeit am Framework ;)

Gruß

Benutzeravatar
dr.e.
Administrator
Beiträge: 4527
Registriert: 04.11.2007, 16:13:53

Re: Wie gehe ich mit welcher Dokumentation vor?

Beitrag von dr.e. » 29.12.2011, 10:42:17

Freut mich, dass du dich nun besser zurecht findest. Eines interessiert mich jedoch noch: was genau gefällt dir am FreeBSD-Ansatz besser? Das Inhaltsverzeichnis auf einer Seite oder der Stil der Dokumentation?
Viele Grüße,
Christian

dirtdevel
Beiträge: 28
Registriert: 26.12.2011, 23:51:51

Re: Wie gehe ich mit welcher Dokumentation vor?

Beitrag von dirtdevel » 29.12.2011, 11:01:09

Das Inhaltsverzeichnis.

Man hat ein Dokument, welches zuerst die Basics behandelt, dann fortgeschrittenere Themen usw..
Die Reihenfolge ist dabei gut gewählt, man kann Themen einfach überspringen und man hat eine feste Struktur/Weg vor Augen.
Man kann sagen, wer das Handbook durchgelesen + verstanden hat, der "kann" FreeBSD ;)

Gruß,
dirtdevel

Benutzeravatar
dr.e.
Administrator
Beiträge: 4527
Registriert: 04.11.2007, 16:13:53

Re: Wie gehe ich mit welcher Dokumentation vor?

Beitrag von dr.e. » 29.12.2011, 14:21:35

Danke für die Anregung. Mal sehen, wie sich diese verarbeiten lässt...
Viele Grüße,
Christian

dirtdevel
Beiträge: 28
Registriert: 26.12.2011, 23:51:51

Re: Wie gehe ich mit welcher Dokumentation vor?

Beitrag von dirtdevel » 29.12.2011, 15:08:32

Keine Ding,

Ganz grob fände ich persönlich sowas in der Art gut:

1. Einleitung
1.1 Was ist ein Framework
1.2 Kurze Zusammenfassung: Warum APF
1.3 Philosphie, Entwickler

2. Installation

3. Konfiguration

4. Erste Schritte - Anfänge
4.1 Eigene Webseite...
4.2 Eigene Webseite mit Kommentaren
4.X Kontinuierliche Steigerung der Schwierigkeit

5. Fortgeschritten
5.1 Browsergames
....

6. Eigenes Projekt (?)
6.1 Idee
6.2 Vorüberlegungen
6.3 Umsetzungen
..

7. APF
7.1 Wie ist das APF aufgebaut
7.2 Wie funktioniert das APF
7.3 Einzelne Komponenten ...

8. APF Erweitern, Mithelfen


So ungefähr. Allerdings bin ich mir unsicher, welche Reihenfolge man wählen sollte: Bedienung vor Verständnis der Grundsätze oder umgekehrt.
Vielleicht kann ich das ja nochmal genauer ausbauen, wenn ich weiter bin

Gruß,
dirtdevel

Benutzeravatar
dr.e.
Administrator
Beiträge: 4527
Registriert: 04.11.2007, 16:13:53

Re: Wie gehe ich mit welcher Dokumentation vor?

Beitrag von dr.e. » 29.12.2011, 17:33:07

Danke für die Anregung. Ich lege mir das Thema auf Wiedervorlage für die Dokumentation von 1.15.
Viele Grüße,
Christian

Antworten

Wer ist online?

Mitglieder in diesem Forum: 0 Mitglieder und 1 Gast