« »

Namensänderungen im Newssystem Modell

17. Juni 2009 Roland

Dieser Artikel ist Teil 64 von 70 der Artikelserie Newssystem

Newssystem

Ich bin dabei mir ein paar Gedanken zu den Modellen des Newssystems zu machen.
Da ich diesmal CakePHP einsetzen will, habe ich ein paar Fragestellungenzu den Modellnamen zu beantworten.
Beispiel:
Bisher habe ich das Modell, welches die einzelnen News beinhaltet, sinnvollerweise NewsModell getauft.
Nun, in CakePHP gilt die Namenskonvention, dass Modelle im Singular und Controller im Plural definiert werden sollen.
Supi!
News ist zwar eigentlich ein Singular, aber ich habe da ein New und ein “s”.
Also wird das kluge CakePHP mir wohl sagen, dass ich hier einen Plural verwende.

Was habe ich getan?

Bevor ich mit dem CakePHP beim Backen ärger bekomme, habe ich mich entschieden die NewsModel Geschichte einfach umzubenennen.
Im Prinzip ist ja jede News ein Artikel.
Also heist das NewsModel ab sofort ArticleModel.

Was muss jetzt geschehen?

Da wir zur Zeit noch in der Konzeption sind, muss nicht viel umgewandelt werden.
Wir müssen lediglich kurz durch alle Artikel durch, in denen das NewsModel vorkommt.
Dank der Volltextsuche sollte das ja wirklich kein Problem darstellen ;)
Dann ersetzen wir in den Artikeln NewsModel in ArticleModel und schon sind wir auf alle Fälle CakePHP konform.

Blogsoftware verwenden hat Vorteile bei der Dokumentation

Die wirkliche Erkenntnis, die ich dank dieser Aktion erhalten habe, ist das es sich wirklich lohnt ein Content Management System, wie beispielsweise einen Blog, für die Dokumentation zu verwenden.
Da alle Dokumente miteinander verlinkt sind, ist die Suche und das Abändern der einzelnen Artikel kein Problem.
Mit der Kommentarfunktion kann man die Änderungen noch protokollieren und so ist die ganze Dokumentation richtig rund!

Fazit

Diese Aktion hat mir gezeigt, dass ein integriertes Tool für die ganze Dokumentation durchaus seinen Reiz hat.
Wir sollten entsprechend über unsere Anforderungsdokumentation nachdenken.
Wenn wir hier ein anderes Werkzeug einsetzen, werden wir sehr schnell inkonsistente Bezeichnungen erhalten.
Die Inflation bei den Blogeinträgen ist zwar nicht unbedingt schön, aber dann haben wir den ganzen Brei auf einem System.
Wir könnten ja noch über die Anforderungsclusterung nachdenken.
Wir können z.B. alle Anforderungen zu einer bestimmten Komponente, oder zu einem bestimmten Thema, in jeweils einen Artikel schreiben.
Damit werden wir deutlich weniger Artikel erhalten und dennoch alle Anforderungen im Blog ablegen können.
Oder wir freuen uns über die vielen Anforderungsartikel.
Eigentlich macht es ja nichts aus, wenn man in einem Blog ein paar hundert Artikel hat. Man kann über die Cloud, oder über die Serie sehr einfach filtern.

Habt ihr hierzu eine Meinung?

Merken und weiterempfehlen Diese Icons verlinken auf Bookmark Dienste bei denen Nutzer neue Inhalte finden und mit anderen teilen können.
  • Technorati
  • Wikio DE
  • Webnews
  • MisterWong
  • Y!GG
  • Digg
  • del.icio.us

Der Beitrag wurde am Mittwoch, den 17. Juni 2009 um 06:03 Uhr veröffentlicht und wurde unter Programmieren abgelegt.
Kurzlink: http://www.baldenhofer.eu/blog/?p=1449

Dir gefiel der Artikel? Dann abonniere doch den RSS Feedrss

Du kannst die Kommentare zu diesem Eintrag durch den RSS 2.0 Feed verfolgen. Du kannst einen Kommentar schreiben, oder einen Trackback auf deiner Seite einrichten.

15 Reaktionen zu “Namensänderungen im Newssystem Modell”

  1. Dirk Deimeke sagt:
    17. Juni 2009 um 06:23

    Bezüglich der Namenskonverntion. Auch, wenn es uncool ist, könnten auch deutsche Bezeichnungen verwendet werden. Wichtig ist meiner Meinung nach, dass die Namen aussagekräftig sind.

    Ich halte gerade für so etwas ein Wiki für besser als ein Blog.

    Das aus zwei Gründen:

    1. Es gibt eine Änderungshistorie.
    2. Die Verlinkung ist einfacher

    Aktuelle Wiki-Systeme bieten ebenfalls Kommentare (Diskussionsseiten) und RSS-Feeds.

  2. Roland sagt:
    17. Juni 2009 um 08:34

    Da bin ich ja mal gespannt was Jozo so herausbekommt.
    Er hat heute noch Zeit sich in Wikis und andere Tools einzulernen.
    Wiki ist meiner Meinung nach eher für Dokumentationsaufbau geeignet als ein Blog.
    Das Ding ist ja genau für die Dokumentation erstellt worden.
    Deutsche Bezeichnungen sind für mich auch ok, auch wenn sie uncool sind.
    Da die ganze Dokumentation in deutsch ist, glaube ich sowieso nicht daran, dass wir hier ein Internationales Projekt haben ;)
    (Also nur Deutssprachige werden mitmachen…)

  3. Dirk Deimeke sagt:
    17. Juni 2009 um 09:06

    Wir reden doch von Dokumentation?!

    Im Artikel schreibst Du das Blogsoftware Vorteile bei der Dokumentation hat, da stimme ich nicht zu.

  4. Roland sagt:
    17. Juni 2009 um 12:45

    Kommt drauf an.
    Im Vergleich zu losen Word Dokumenten bringt sie, meiner Meinung nach, schon Vorteile mit sich.
    Immerhin sind die Artikel untereinander verlinkt, können von mehreren Personen gleichzeitig eingesehen werden und erlauben es durch Kommentare weitere Informationen hinzuzufügen.
    Deshalb hat sie schon Vorteile gegenüber z.B. Dateiordnern.

  5. Dirk Deimeke sagt:
    17. Juni 2009 um 12:47

    Aus der Nummer kommst Du nicht raus :-)

    Ich vergleiche Wiki und Blogsoftware, nicht Blogsoftware und etwas anderes …

  6. Roland sagt:
    17. Juni 2009 um 14:29

    Gut, dann ist Blogsoftware nicht das richtige Werkzeug.
    Wiki ist dafür deutlich besser geeignet.
    (Wir können ja ein WordPress Wiki Plugin nehmen, dann haben wir auch einen Blog ;) )

  7. Ute sagt:
    17. Juni 2009 um 14:45

    Ich habe mit Jozo gestern und heute nochmal einiges andiskutiert. Ich hoffe er wird daraus einen Artikel basteln, mit Vor- und Nachteilen, so dass anhand dessen noch diskutiert werden kann. Angedacht bisher:
    Blog
    Tabellenkalkulation wie OOo
    Wiki
    Wiki kombiniert mit Blog (WP-Plugin)
    miradlo-RE-Oberfläche (Requirements Engineering)
    Gobby
    PHProject
    Google-Docs (Jozo findet sie toll, muss sie jedoch diskutieren, weil Ute gegen fremdgehostet ist)
    Ich glaube das war’s mal soweit…

  8. Dirk Deimeke sagt:
    17. Juni 2009 um 15:18

    @Roland: :-D

    @Ute: Das ist ja schon einmal eine ganze Menge.

  9. Ute sagt:
    17. Juni 2009 um 16:31

    Da siehste mal, an was ich alles denke… ;) Fehlt nur noch Jozos Input…

  10. Roland sagt:
    17. Juni 2009 um 16:36

    Hm…
    Ich denke es fehlt eher Jozos Output :)

  11. Dirk Deimeke sagt:
    17. Juni 2009 um 16:38

    (Losgelöst von diesem Projekt lohnt sich ein Blick auf Trac).

  12. Ute sagt:
    17. Juni 2009 um 16:43

    @Roland

    Aus Jozo kommt Output, der sollte dann hier als Input rein… ;)

    @Dirk Juhu, noch ein Tool…

    Jungs, falls wir in zehn Jahren das perfekte Tool haben, können wir ja nochmal überlegen…

    Denn ganz ursprünglich:
    Wollte ich in einer bestehenden Newsfunktion noch ein Bildle dazu. Ich dachte so an “in zwei Stunden mal eben”… ;)

  13. Dirk Deimeke sagt:
    17. Juni 2009 um 16:46

    @Ute: ;-)

    Trac habt Ihr bestimmt schon häufig gesehen. Zum Beispiel hier http://core.trac.wordpress.org/

    Das nutze ich für alle internen Geschichten. Ausschliesslich.

  14. Ute sagt:
    17. Juni 2009 um 16:51

    Trac habt Ihr bestimmt schon häufig gesehen.

    Ich ja, Roland nicht grad von WP aber sonst schon, ob Jozo: keine Ahnung, weiß nicht, kann’s nicht sagen… ;)

  15. Ute sagt:
    17. Juni 2009 um 17:19

    Sodele, auf geht’s:
    stürzt euch drauf…
    http://www.baldenhofer.eu/blog/azubi-ecke/ein-tool-fuer-die-anforderungen

    Der arme Jozo hat die Screenshots vergessen, aber mal zu allem ein bisschen was geschrieben…

    Fröhliches Diskutieren!

Schreibe mir

zum Seitenanfang