Schnittstellendokumentation

[Wim_TheRun]

Hallo zusammen,

Habt ihr einen Denkanstoß für mich, wie ich am besten eine Schnittstelle (EDIFACT ORDERS 96A) dokumentieren kann?

Das rundherum habe ich schon fast fertig, mir fehlt nurnoch die eigentliche. Domumentation...

Hat hier schonmal jemand Erfahrung o.ä. ?

Danke im Voraus für die Antworten

Wim

[Wim_TheRun]

Hat sich erledigt. Ich habe folgende Gliederung mit entsprechendem Inhalt gewählt:

EINLEITUNG

1 BEGRÜNDUNG ZUR ÄNDERUNG DER GLIEDERUNG

2 DEFINITIONSPHASE

2.1 IST-ANALYSE

2.2 SOLL-ZUSTAND

3 PLANUNGSPHASE

3.1 ZEIT- UND RESSOURCENPLANUNG

3.2 KOSTENPLANUNG

4 DURCHFÜHRUNGSPHASE

4.1 VERWENDETE HARDWARE

4.2 VERWENDETE SOFTWARE

4.3 TECHNISCHE VORBEREITUNGEN

4.4 FACHLICHE VORAUSSETZUNGEN FÜR VERBUCHUNG

4.5 KOMMUNIKATIONSKANÄLE UND INTEGRATION FLOWS

4.6 ÜBERSICHT DES EDI PROZESSES

4.7 BESCHREIBUNG DES VERBUCHUNGSPROZESSES

4.8 MAPPING ALLGEMEIN

4.9 GRAPHISCHES MAPPING

4.9.1 Vorteile graphisches Mapping

4.9.2 Beispiele graphischer Mappings

4.10 MAPPING BEISPIEL

4.10.1 Kopfebene

4.10.2 Positionsebene

5 TESTPHASE

5.1 QUALITÄTSSICHERUNG

5.2 MONITORING

6 PRODUKTIVPHASE

6.1 LIVE TEST MIT KUNDE

7 GLOSSAR

8 QUELLEN

9 ABBILDUNGSVERZEICHNIS

10 ANHANG

10.1 ZEIT- UND RESSOURCENPLAN

10.2 GUIDELINE VON KUNDE

10.3 ORDERS D96A BEISPIELDATEI VON KUNDE

10.4 BILDLICHE DARSTELLUNG EDI PROZESS

10.5 BILDLICHE DARSTELLUNG HEUTIGER PROZESS

10.6 BILDLICHE DARSTELLUNG PROZESSÜBERSICHT

10.7 ANSICHT FEHLERHAFTE IDOCS IM IDOC-MONITOR IN SAP

10.8 ANSICHT FEHLERFREIE IDOCS IM IDOC-MONITOR IN SAP

10.9 KOMMUNIKATIONSKANAL KUNDE

10.10 IFLOW IN BPMN NOTATION

10.11 TESTBERICHTE ZU SOFTWARETESTS

10.12 BEISPIELE FÜR QUALITÄTSSICHERUNG

10.12.1 QS mit E-Mail Anhang

10.12.2 QS auf Feldmapping Ebene

10.13 PERSÖNLICHE ERKLÄRUNG

10.14 BESTÄTIGUNG ÜBER DURCHGEFÜHRTE PROJEKTARBEIT

10.15 PROTOKOLL ÜBER DURCHGEFÜHRTE PROJEKTARBEIT

[Rehmus]

mein tipp an dich:

da du nur 10 seiten Dokumentation schreiben solltest (laut IHK), solltest du Sachen wie Glossar, Quellen, ... als Anhang mit deiner Dokumentation schicken und innerhalb der Doku vielleicht nur 1-2 Sätze zusammengefasst und dann auf den Anhang verweisen. So habe ich meine DOKU nun auf 10 Seiten wo alles drinn steht und wenn ses ausfühlicher haben wollen können se nen Anhang durchlesen mit je 1-2 Seiten.

[Nopp]

mein tipp an dich:

da du nur 10 seiten Dokumentation schreiben solltest (laut IHK), solltest du Sachen wie Glossar, Quellen, ... als Anhang mit deiner Dokumentation schicken und innerhalb der Doku vielleicht nur 1-2 Sätze zusammengefasst und dann auf den Anhang verweisen. So habe ich meine DOKU nun auf 10 Seiten wo alles drinn steht und wenn ses ausfühlicher haben wollen können se nen Anhang durchlesen mit je 1-2 Seiten.

Die verschiedenen IHKs schicken genau das, was du geschrieben hast aber als definierte Anweisung mit. Bei mir z.B. stand drin, dass die IHK das Glossar etc, nicht in der Seitenzahl berücksichtigen wird. Bei anderen außerhalb meines Ortes war dies nicht der Fall.

[Wim_TheRun]

Danke für den Tipp, aber abgesehen davon, dass gestern Abgabetermin war, stand bei mir 10-15 Seiten Dokumentation. von daher würde es schon passen.

Das die IHK (IHK Giessen-Friedberg) Glossar etc. nicht unter den 10-15 Seiten berücksichtigt stand bei uns nicht. Wie sie es werten ist egal, es umfasst nicht mehr als 15 Seiten, maximal 15,5 aber daran solls mal nicht scheitern.