Dokumentation der DB-Struktur, des Codes und der Styles

[Acid]

Ich hab ma angefangen über die Datenbankstruktur, Dateien und den Style Sheets bissel was aufzuschreiben, was ma dann als Dokumentation benutzen kann.

http://www.acidjunky.de/205/doku2.php

Momentan is des alles noch in txt-Dateien gepackt , zur Darstellung auf obiger Seite habe ich nur jeweils 2 Beispiele aufgeschrieben und die Darstellung dient nur Veranschaulichung wie´s irgendwann ma aussehen könnte (hab halt nur schnell ma ´n paar Tabellen zusammengeschoben).

Ich wollte nur erstmal fragen, ob jemand Anregungen, Kritik oder sonstwas diesbezüglich hat. Ist es verständlich, hat´s überhaupt Sinn , soll´s anders aufgebaut sein und das wichtigste: fehlt was?

[AWSW]

Hallo Acid,
finde ich eine geniale Sache, damit man die Zusammenhänge schneller nachvollziehen kann.

Sieht IMHO sehr gut aus - derzeit keine Verbesserungsvorschläge

[Mister_X]

Erstmal finde ich das eine gute Idee.
Zu CSS: Wären nicht vielleicht Bilder anschaulicher als nur Text ?
Vielleicht wäre es auch noch gut zu erklären was die einzelnen Felder im Adminbereich -> Kategorie Styles/Themes -> Einstellungen -> Bearbeiten bewirken.

Zu Dateien: IMHO kriegt man ja ganz schnell raus was für TPL Dateien zu einer PHP Datei gehören indem man die PHP Datei mit einem Editor öffnet und nach "tpl" sucht.

Zu Datenbank: Jau find ich gut, vielleicht noch zw. die einzelnen DB-Felder eine Trennlinie machen.

[Acid]

Zu CSS: Wären nicht vielleicht Bilder anschaulicher als nur Text ?

..natürlich, wird auch noch kommen.

Vielleicht wäre es auch noch gut zu erklären was die einzelnen Felder im Adminbereich -> Kategorie Styles/Themes -> Einstellungen -> Bearbeiten bewirken.

...wird das nicht scho in der Doku hier auf phpbb.de erklärt ?

Zu Dateien: IMHO kriegt man ja ganz schnell raus was für TPL Dateien zu einer PHP Datei gehören indem man die PHP Datei mit einem Editor öffnet und nach "tpl" sucht.

sicherlich, obwohl Noob Nr. 10 nichma weiss was ´n Editor is.
Aber bei "Dateien" will ich dann noch reinschreiben, was dort in einem Standard-phpBB für Templatevariabeln vorkommen und was sie bedeuten (naja, vielleicht nicht komplett... eher übersichtshalber). Was dann vielleicht für einen Anfänger beim Templateerstellen behilflich sein kann.


Aber Danke für den Kommentar. Übrigens, wo sind die ganzen Leute, die immer nach Anleitungen schreien, wenn man sie ma braucht.

[itst]

Gefällt mir sehr gut!

Was ich nicht ganz verstehe: wozu soll der Link von den CSS zu den Dateien gut sein?

PS: Vor allem die Fussnoten in der DB zu so Sachen wie "auto_increment" sind Klasse. "Heap" als Tabellentyp für die *_sessions wäre noch so ein Fussnotenkandidat.

[Acid]

wozu soll der Link von den CSS zu den Dateien gut sein?

..is mir jetzt nich ganz verständlich. Die drei Links (Datenbank,Dateien,CSS) dienen eigentlich nur zur Navigation. Und... optisch is es erstmal nur zusammengewürfelt und wird später getrennt behandelt.

PS: Vor allem die Fussnoten in der DB zu so Sachen wie "auto_increment" sind Klasse. "Heap" als Tabellentyp für die *_sessions wäre noch so ein Fussnotenkandidat.

ja.. da will ich dann so einiges eintragen (z.B. auch "timestamp", "Verschlüsselung der Passwörter, IPs" ...so Sachen halt).

[itst]

Wenn Du in "CSS" auf "body" z. B. klickst, landest Du in den "Dateien".

[PhilippK]

Ich würde beim Datenbank-Teil noch die Beziehungen etwas deutlicher machen. Also z.B.:

Feld: group_id (aus prefix_group_table)
Funktion/Inhalt: id des berechtigten Users bzw. der berechtigten Usergruppe
Werte: entspricht user_id/group_id des jeweiligen Users

Wie kann man dich dabei unterstützen? Schließlich bin ich ja an der Sache nicht ganz unschuldig

Gruß, Philipp

[Acid]

Wenn Du in "CSS" auf "body" z. B. klickst, landest Du in den "Dateien".

aso... das einfach ned beachten, is´n Fehler meinerseits.

Ich würde beim Datenbank-Teil noch die Beziehungen etwas deutlicher machen.

hmm... könnte man, jedoch stehen die Felder ja direkt unter der jeweiligen Tabelle (sollte also eigentlich (;)) deutlich erkennbar sein, wo´s hingehört). Aber wie gesagt optisch ist es momentan sowieso nur 0815...

Wie kann man dich dabei unterstützen?

Das Hauptaugenmerk liegt auf dem Bereich "Datenbank" (was dann auch als erstes fertig sein wird) und da werden sicherlich noch einiges an Erklärungen ausgebessert werden müssen (z.B. was die Tabellen für´ne Funktion haben oder später die Fussnoten (s. itst´s Beitrag)).
Also könnte man scho einige Erläuterungen zusammenfassen (heap, md5 ...so´n Zeugs halt).

Natürlich soll das Ganze dann als Doku2 hier auf phpbb.de platziert werden... wie würde das am besten passen? Als *.php mit den passenden *.tpl´s ?

[PhilippK]

Wie kann man dich dabei unterstützen?

Das Hauptaugenmerk liegt auf dem Bereich "Datenbank" (was dann auch als erstes fertig sein wird) und da werden sicherlich noch einiges an Erklärungen ausgebessert werden müssen (z.B. was die Tabellen für´ne Funktion haben oder später die Fussnoten (s. itst´s Beitrag)).
Also könnte man scho einige Erläuterungen zusammenfassen (heap, md5 ...so´n Zeugs halt).

Sag was ich machen soll und dann bekomm ich das schon irgendwie hin

Gruß, Philipp