You are not logged in.

wcf.regNote.message

flo

Unregistered

1

Tuesday, August 11th 2009, 3:30pm

Wie erstelle ich ne gute SS-Beschreibung?

morgen...
wir haben auf der arbeit so ne art wiki, in der halt probleme und how to's gesammelt werden...
so nun vertreiben wir ne software, die daten zu anderen verfahren exportieren kann und daten aus anderen verfahren importieren kann.
das ganze läuft über schnittstellen..
nun möchte ich nach und nach diese schnittstellen ins wiki einpflegen. bin mir aber noch nicht sicher, wie ich die beiträge generell struktuerieren sollte....
habt ihr da ne idee, wie man das standardmäßig machen kann?
zb....
  1. kurzbeschreibung
  2. kunden
  3. Funktionsweise
an sowas in der art hab ich gedacht.. noch ne idee?

Prometheus

Administrator

Posts: 3,278

  • Send private message

2

Tuesday, August 11th 2009, 4:50pm

Meinst Du jetzt wie die Informationen strukturiert werden sollen oder welche Informationen man überhaupt preis geben sollte? Ich denke mal am Anfang sollte eine Kurzbeschreibung stehen damit man direkt in wenigen Sätzen sieht um was es geht. Dann etwas ausführlicher die Funktionsbeschreibung und gegen Ende eine technische Referenz wie die Schnittstelle arbeitet und zu was sie kompetiebel ist oder so.

Schau doch mal bei Wikipedia wie die sowas strukturieren. Bei den meisten Dingen finde ich das immer sehr gut. Hier mal ein Beispiel -> http://de.wikipedia.org/wiki/Schnittstelle

Ansonsten erklär mal etwas genauer was Du brauchst kann mir nicht so gut vorstellen was Du meinst.
Jedwege Anfragen bitte an Technomausi oder ShaoKhan richten. Dieses Konto ist und bleibt inaktiv.

flo

Unregistered

3

Tuesday, August 11th 2009, 8:07pm

nuja..
wir vertreiben halt eine gebührenkases für kommunale anwender. für kommunen gibts ja ne menge programme und deshalb müssen wir natürlich für viele programme schnittstellen bieten, damit die kommunalen anwender verschiedene programme benutzen können. mal ein kleines beispiel:
bei der abteilung kfz wird ein neufahrzeug angemeldet. die haben ein programm in dem das protokolliert wird und das die inforamtionen weiter gibt an keine ahnung.. das bundesamt für kfz-anmeldungen :P
so der vorgang konnte mit dem programm gemacht werden. nun kostet so ne kfz-anmeldung ja auch geld.. und da kommt dann unsere software ins spiel. der kunde will jetzt daten aus seinem kfz programm (zb kundenname, vorgangsnr, grund für die buchung, preis - mal aus der luft gegriffen) per knopfdruck in unser programm übergeben, damit die gebühren auch abgerechnet werden können. und wir haben halt solche schnittstellen zu vielen programmen. sowohl für import als auch für export. da möchte ich gerne mal ein anständiges wiki reinbringen, damit zb ein azubi wie ich es bin schnell nachschauen kann was die SS macht und wie sie grob funktioniert. dieses wiki ist auch nur für uns intern gedacht, das soll weder ein kunde noch die konkurrenz sehen :P tlw sind die SS auch für einzelne kunden spezifisch erstellt worden.. daher ist der punkt "kunden" halt mehr oder minder interessant
- kurzbeschreibung
- kunden
- Funktionsbeschreibung
- technische Referenz
so in etwa sähe dann jetzt die gliederung aus - noch jemand ne spitzen idee? :P
ich weiß noch nicht wie ich die technische referenz aufbauen soll, hatte bisher aber auch nur mit 2 schnittstellen bekanntschaft.. eventuell wird dann funktionsbeschreibung und techn. referenz in einen punkt zusammen fließen...

Prometheus

Administrator

Posts: 3,278

  • Send private message

4

Tuesday, August 11th 2009, 8:33pm

OK ich verstehe jetzt was gemeint ist. Naja da gibt es mehrere Ansätze was brauchbar wäre für Azubi's oder auch stellenweise Kunden oder sonstige Personen. Gut wäre z.B. eine Liste mit allen Programmen für die es Schnittstellen gibt. Dann vielleicht eine Gruppierung wenn z.B. eine Schnittstelle für mehrere Programme brauchbar ist (z.B. XML export und import für 5 verschiedene Programme). Die technische Referenz sollte auf jeden Fall umfassen, welche spezifischen Daten ausgetauscht werden können, ob dies direkt passiert (Daten werden direkt in eine DB oder aus einer DB vom entsprechenden Programm genommen oder ob die Daten erst in Dateien ausgelagert werden und dann wieder importiert. Dann die benötigten Leistungsdaten für Rechner und / oder Server und lauter so sachen. Im Grunde kannst Du jede Information festhalten welche irgendwie damit zu tun hat. Und dann eben mit Querverweisen arbeiten wie Wikipedia und z.B. für XML eine begriffserklärung und eine Übersicht was damit gemacht werden kann und lauter sowas.

Ich denke erst beim schreiben merkst Du wenn irgendwas anders aufgebaut sein sollte damit es besser zu lesen ist.
Jedwege Anfragen bitte an Technomausi oder ShaoKhan richten. Dieses Konto ist und bleibt inaktiv.

flo

Unregistered

5

Wednesday, August 12th 2009, 9:03am

najo ich mach mir die tage noch ein paar gedanken...
das läuft ja auch eher so nebenher...

Similar threads

wcf.user.socialbookmarks.titel