WebsiteBaker Support (2.8.x) > Diskussion über WB (closed)

Module Guidelines: Vorschläge, Kritik & Mitarbeit

<< < (7/11) > >>

Waldschwein:

--- Quote from: Stefek on March 04, 2010, 02:53:49 PM ---Doch ein solcher "Schaltkreis" wird nie die Frage beantworten, ob das Modul "brauchbar" oder "beliebt" ist, sondern nur, ob es gemäß gewißen willkürlichen Regeln programmiert wurde und keine Fehler ausgibt.

--- End quote ---

Ganz genau.  :wink: Mehr machen muss dann die Community. Das Team kann und soll nicht bewerten, ob Module brauchbar und beliebt sind - dafür gibt's ja dann einen Add-on Showcase mit (wie immer nicht aussagekräftigem) Rating, Download-Zahlen etc. Das Team kann und darf nicht mehr als den Rahmen bieten, das Bild muss schon jeder selber malen, höchsten fragen, wie dies und das geht.

Gruß Michael

doc:
Hi,

hier mal MEIN Versuch einer Definition der Begriffe "Guideline" und "Handbuch" (aus meiner Sicht).

Versuch anhand eines abstrakten Beispiels:
Wenn man sich ein Handbuch als Gebrauchsanleitung eines Autos vorstellt, entsprechen "Guidelines" einem Auto Prüfkatalog z.B. beim TÜV. Wenn das Auto alle im Prüfkatalog festgelegten Tests bestanden hat, bekommt es vom TÜV eine TÜV Plakette. Ansonsten gibt es ein Mängelschreiben und man wird gebeten nach Behebung der Mängel nochmals vorstellig zu werden :wink:

Daher muss aus meiner Sicht das WB-Team (z.B. Quality Team) die Guidelines erstellen und nicht die Benutzer, sonst ist das Chaos perfekt. Handbücher hingegen können auch von Leuten erstellt werden, welche sich mit einem Produkt hinreichend vertraut gemacht haben (Designerhandbuch, Entwicklerhandbuch etc.).

Zusammenfassung:
Handbücher erklären die Schritte die nötig sind, um ein Modul oder ein Template für WebsiteBaker zu erstellen (didaktisch). Beim "Designer Handbuch" habe ich mich damals entschieden, die notwendigen Schritte der WebsiteBaker Templateerstelltung auf Basis einer statischen HTML Vorlage zu beschreiben. Diesen Teil könnte man z.B. prima um die Gestaltung eines Menüs mit Hilfe von Showmenü mittels CSS ergänzen. Der Module Primer ging ebenfalls in die Richtung (Handbuch).

Guidelines hingegegen sind Regelwerke, welche formale Aspekte behandeln (siehe Template-Guidelines).

Hier steht u.a. dass ein Add-on nur in den WB Showcase aufgenommen wird, wenn es sich ohne Fehler installieren und deinstallieren lässt (z.B. bei error_reporting E_ALL), wenn in allen Dateien Copyright Hinweise vorhanden sind, keine Benutzereingaben ungefiltert im Browser ausgegeben werden (XSS), oder ungefiltert in SQL Queries verwendet werden (SQL Injection).

Diese Regeln müssen vom WebsiteBaker Team erstellt werden. Daher fände ich es nach wie vor gut, wenn DarkViper seine Vorschläge mal posten würde.

Doc

P.S.: Man kann natürlich auch Handbücher und Guidelines mischen, davon würde ich allerdings abraten.
P.P.S.: Guidelines und Handbücher sind für WB 2.x und 3.x verschieden

Stefek:

--- Quote from: doc on March 04, 2010, 05:21:43 PM ---Versuch anhand eines abstrakten Beispiels:
Wenn man sich ein Handbuch als Gebrauchsanleitung eines Autos vorstellt, entsprechen "Guidelines" einem Auto Prüfkatalog z.B. beim TÜV. Wenn das Auto alle im Prüfkatalog festgelegten Tests bestanden hat, bekommt es vom TÜV eine TÜV Plakette. Ansonsten gibt es ein Mängelschreiben und man wird gebeten nach Behebung der Mängel nochmals vorstellig zu werden :wink:

Daher muss aus meiner Sicht das WB-Team (z.B. Quality Team) die Guidelines erstellen und nicht die Benutzer, sonst ist das Chaos perfekt. Handbücher hingegen können auch von Leuten erstellt werden, welche sich mit einem Produkt hinreichend vertraut gemacht haben (Designerhandbuch, Entwicklerhandbuch etc.).

--- End quote ---

Ich mag Docs Allegorie und kann ihm nur zustimmen.
Handbücher, HowTos und Tutorials sind eine andere Hausnummer als Richtlinen (=Guidelines).

Wenn Guidelines als "Grundlage" zur Aufnahme der Moduole in der offiziellen Repository dienen sollen, dann sollten sie auch von einer offiziellen Autorität etabliert werden.

Keins meiner Templates hat sich je um Aufnahme auf der Repository bemüht, weil ich weiß, dass ich bestimmte Guideline Auflagen "verletze" (z.B. ordne ich die css files anders an als empfohlen und anderen Kram, von dem er mir praktischer erscheint auf meine Art). Aber das ist eine bewußte Entscheidung von mir.

Genau so würde es für Module der Fall sein - "Verletzung" der Guidelines, keine Aufnahme.
Wer dann den Anspruch erhebt, sein Modul vorzustellen, sollte sich mit den Guidelines vertraut machen und sie befolgen.

Es kann auch so etwas geben wie _zu_starre_guidelin es_ , die wenig Raum für Eigeninitiative oder Kreativität bieten und es sollte berücksichtigt und eingerichtet werden, dass man Entwicklern ermöglicht, in bestimmten Fällen eine Lockerung/Erweiterung/Revision der Guidelines zu ersuchen - vorausgesetzt der Entwickler ist ein Profi und sein Vorschlag sinvoll, statt nur eine "Umgehung der Regeln aufgrund ihres Nichtverstehens zu versuchen".

Na, sieht mir aus, als wenn hier tatsächlich was Konstruktives herauskommen könnte in diesem Thread.

Gruß,
Stefek

doc:
Hi,


--- Quote from: Stefek ---Keins meiner Templates hat sich je um Aufnahme auf der Repository bemüht, weil ich weiß, dass ich bestimmte Guideline Auflagen "verletze" (z.B. ordne ich die css files anders an als empfohlen und anderen Kram, von dem er mir praktischer erscheint auf meine Art). Aber das ist eine bewußte Entscheidung von mir.
--- End quote ---
Änderungs- oder Verbesserungsvorsch läge diesbezüglich sind vom aktuellen WB-Team bestimmt gerne gesehen, also nur zu. Auch Chio handelt einiges anders. Also sollte man sich fragen warum, macht das Sinn und sollte man das ganze hier oder da lockern - fertig.

Es macht nur wenig Sinn, Modulguidelines ohne Einblick in die derzeit vorhandenen Resourcen (Teammitglieder), deren Kenntnisstand, möglicher Prozessabläufe und Beschlüssen bezüglich Weiterentwicklung (WB 2.x, WB 3.x) zu erstellen. Daher meine Bitte DarkViper möge doch mal seinen groben ersten Entwurf vorstellen.

Hoffe meine Meinung dazu ist nun etwas klarer rübergekommen. Und nun bin ich auch wieder ruhig :wink:

Doc

Luisehahne:
Danke Bianca,

du sprichst mir aus der Seele. Chio ist übrigens für mich ein hervorragender Fachredakteur.

Dietmar

Navigation

[0] Message Index

[#] Next page

[*] Previous page