Eigenentwicklung dokumentieren

Bild Microsoft Dynamics NAV 2017

Eigenentwicklung dokumentieren

Beitragvon stony » 18. Januar 2017 11:05

Hallo,
wie geht ihr mit diesen Thema um. Sprich man passt in NAV an bzw. entwickelt ganze Prozess neu.
Wie dokumentiert ihr das fĂĽr euch bzw. fĂĽr die Benutzer und welche Werkzeuge verwendet ihr dafĂĽr.

Z.B. eine Erklärung der Felder auf eine Page und wie der ganze Prozess funktioniert.

Danke und lg
stony
stony
 
Beiträge: 1100
Registriert: 24. April 2006 11:31
Bezug zu Microsoft Dynamics: End-Anwender

Re: Eigenentwicklung dokumentieren

Beitragvon enh » 18. Januar 2017 15:07

Kommt drauf an. Je nach Bedarf oder Anforderung des jeweiligen Kunden. Manchmal Handbuch in Word, das aber i. d. R. dann vom Kunden geschrieben wird. Die NAV Hilfe haben wir noch nie angepasst, die wird von den Kunden / Anwendern erfahrungsgemäß ohnehin nie verwendet.
enh
 
Beiträge: 2330
Registriert: 5. Februar 2014 15:42
Bezug zu Microsoft Dynamics: Microsoft Partner
Microsoft Dynamics Produkt: Microsoft Dynamics NAV

Re: Eigenentwicklung dokumentieren

Beitragvon Timo Lässer » 18. Januar 2017 16:27

Ich kann da aus eigener Erfahrung den "Object Manager Advanced" von IDYN.nl uneingeschränkt empfehlen.

Die Anforderungen nehmen wir in OTRS auf, und die OTRS-Ticket-ID verwenden wir dann als OMA-Projektnr., welche dann auch in den Objekten und dem C/AL-Code zur Dokumentation verwendet wird.
Da man zu einem Ticket eventuell ein paar Tage später nochmal eine Nachbesserung programmiert, enthält die OMA-Projektnr. noch eine fortlaufende Nummer.
In dem OMA-Projekt wird auch immer die URL zu dem OTRS-Ticket hinterlegt, so dass auch noch Jahre später nachvollzogen werden kann, wer wann was warum gefordert hat, und wie es dann umgesetzt wurde.

Da wir gerade dabei sind, unsere 7 Jahre alte, hochgradig angepasste NAV5.0-Lösung auf NAV2017 zu bringen, erfahren wir, wie sinnvoll diese Entscheidung vor 8 Jahren war, da selbst heute noch die ältesten Anpassungen im Detail nachvollziehbar sind.
Ebenso können wir über die OMA-Projekte (bzw. notfalls über die OMA-Funktion "Search String in C/AL Code") wirklich alle Stellen ausfindig machen, welche für diese Anforderung mal angepasst wurden, selbst wenn Teile davon heute auskommentiert sind.

Das OTRS-Ticketsystem war nicht von Anfang an im Einsatz, aber anhand der OMA-Projektnr. können wir erkennen, ob die Anforderung in OTRS, SharePoint oder in Word geschriebenen Spezifikationen definiert ist.
Beispiel:
#CR123-01: Initiale Anpassung (-01) aus dem Word-Dokument CR123 (ChangeRequest) auf dem Dateiserver
#SP456-02: Zweite Anpassung (-02) zu dem SharePoint-Listeneintrag mit der eindeutigen Nummer 456
#2012060310000789-01: Erste Anpassung (-01) zum OTRS-Ticket 2012060310000789.

Fazit:
Man sollte ein zentrales "Anforderungs-Verwaltungs-System" verwenden, welches auch in 10 Jahren noch existiert, damit man die HintergrĂĽnde zu der Anforderung nachschlagen kann. (Bei uns: OTRS)
Man sollte ein einfach zu bedienendes, vollumfängliches Quellcode-Verwaltungs-System verwenden, bei dem man quasi nicht vergessen kann, eine Änderung zu protokollieren. (Bei uns: OMA)
Gruß, Timo Lässer

Frage beantwortet? Schreibe bitte "[Gelöst]" vor den Titel deines ersten Beitrags.
Bitte erst suchen, dann fragen. Bitte beachte den kleinen Community-Knigge.
Kein Support per PN, E-Mail, Instant Messanger, Soziale Netzwerke, Telefon oder Fax! DafĂĽr ist dieses Forum da.
Hier kannst du fĂĽr MSDynamics.de spenden.
Benutzeravatar
Timo Lässer
Administrator
Administrator
 
Beiträge: 5274
Registriert: 14. November 2004 22:18
Wohnort: DE 49716 Meppen
Arbeitsort: DE 49733 Haren (Ems)
Bezug zu Microsoft Dynamics: End-Anwender
Microsoft Dynamics Produkt: Microsoft Dynamics NAV
Microsoft Dynamics Version: 1.10a - 2018, BC14, BC21

Re: Eigenentwicklung dokumentieren

Beitragvon enh » 18. Januar 2017 17:03

Ich hatte die Frage so verstanden dass es um Anwender Doku geht. Die Dokumentation der Programm-Code-Ă„nderungen machen wir auch ĂĽber ein Ticketsystem und entsprechende Verweise in der Doku der Objekte. Aber mehr manuell und nicht so automatisiert verlinkt wie Timo.
enh
 
Beiträge: 2330
Registriert: 5. Februar 2014 15:42
Bezug zu Microsoft Dynamics: Microsoft Partner
Microsoft Dynamics Produkt: Microsoft Dynamics NAV

Re: Eigenentwicklung dokumentieren

Beitragvon Timo Lässer » 19. Januar 2017 09:29

Ach so. :oops:
Typischer Programmierer-Fehler, wir denken einfach zu technisch. :mrgreen:

FĂĽr die Anwender erstellen wir (jedoch nicht die Programmierer) die Dokumentation in Word und legen diese dann als PDF auf einem zentralen (fĂĽr Anwender schreibgeschĂĽtzten) Verzeichnis ab.
Zukünftig werden die Prozessabläufe zusätzlich noch in einer Prozess-Modellierungs-Software abgebildet.
Und wenn alles so läuft, wie wir es uns wünschen, dann können die PDF-Dateien mit der Anwender-Doku direkt aus der Prozess-Modellierungs-Software aufgerufen werden.
Der Anwender klickt sich bis zu dem gewĂĽnschten Prozess durch und ruft von dort die Anwender-Doku auf.

Das klingt im ersten Moment nach sehr viel Arbeit. Ist es auch. :lol:
Es zahlt sich aber im Geschäftsalltag aus, da die Anwender wissen, wo sie die Dokumentation zu dem entsprechenden Geschäftsprozess finden.
Dies entlastet den Support und reduziert die "Ausfallzeit" der Anwender, da sie schneller die Antwort auf ihre Frage finden.
Und spätestens beim nächsten größeren Upgrade holt man die Kosten und die Zeit ganz schnell wieder heraus, da man ja alle individuellen Prozesse an zentraler Stelle sauber beschrieben hat.
Die Anzahl und Dauer der erforderlichen Workshops reduziert sich dann erheblich, da man nur noch bewerten muss, ob dieser Prozess so noch benötigt wird, technisch anders abgebildet werden kann/muss oder durch neue Features im NAV-Standard abgebildet werden kann.
Gruß, Timo Lässer

Frage beantwortet? Schreibe bitte "[Gelöst]" vor den Titel deines ersten Beitrags.
Bitte erst suchen, dann fragen. Bitte beachte den kleinen Community-Knigge.
Kein Support per PN, E-Mail, Instant Messanger, Soziale Netzwerke, Telefon oder Fax! DafĂĽr ist dieses Forum da.
Hier kannst du fĂĽr MSDynamics.de spenden.
Benutzeravatar
Timo Lässer
Administrator
Administrator
 
Beiträge: 5274
Registriert: 14. November 2004 22:18
Wohnort: DE 49716 Meppen
Arbeitsort: DE 49733 Haren (Ems)
Bezug zu Microsoft Dynamics: End-Anwender
Microsoft Dynamics Produkt: Microsoft Dynamics NAV
Microsoft Dynamics Version: 1.10a - 2018, BC14, BC21

Re: Eigenentwicklung dokumentieren

Beitragvon Atlan » 29. März 2017 10:42

Hallo zusammen,

Als Partner bzw. Entwickler in eigener Sache habe ich es möglichst auf 4 Dinge geachtet:
1) Dokumentation im Code: Anfangsmarke / Eigener Code / Endemarke
2) Objekte: In allen angepassten Objekten eine kleine Ă„nderungsdoku im Kopf inkl. Versions-Nr.
3) Anwender-Doku: Word- bzw. pdf-Dokument mit dem was der Anwender ĂĽber den Prozess wissen muss, evtl. mit Screen-Shots
4) technische Doku: Interne Beschreibung der Eigenentwicklung mit allen angepassten Tabellen, Abhängigkeiten und Prozess-Abläufen.

Das ist zwar viel Arbeit, aber wie schon gesagt, es lohnt sich !

GrĂĽĂźe
ATLAN
Atlan
Microsoft Partner
Microsoft Partner
 
Beiträge: 128
Registriert: 29. Januar 2009 14:49
Wohnort: Schorndorf
Realer Name: Hermann Schubert
Arbeitsort: Schorndorf
Bezug zu Microsoft Dynamics: End-Anwender
Microsoft Dynamics Produkt: Microsoft Dynamics NAV
Microsoft Dynamics Version: NAV2015,NAV2017

Re: Eigenentwicklung dokumentieren

Beitragvon JoelMachado » 25. August 2017 09:09

Hallo zusammen,

gibt es im Bezug auf die Dokumentation im Quellcode von Microsoft Vorgaben, wie man dies Strukturieren sollte?
JoelMachado
 
Beiträge: 5
Registriert: 19. Dezember 2016 14:42
Realer Name: Joel Machado
Arbeitsort: Leipzig
Bezug zu Microsoft Dynamics: SchĂĽler / Student
Microsoft Dynamics Produkt: Microsoft Dynamics NAV

Re: Eigenentwicklung dokumentieren

Beitragvon Natalie » 25. August 2017 09:24

JoelMachado hat geschrieben:gibt es im Bezug auf die Dokumentation im Quellcode von Microsoft Vorgaben, wie man dies Strukturieren sollte?

Microsoft gibt intern nur vor, wie neuer Code auszusehen hat:
https://blogs.msdn.microsoft.com/nav/20 ... openhagen/
https://msdn.microsoft.com/en-us/dynami ... ing-format
ABER Microsoft selbst dokumentiert die Ă„nderungen nicht, weder im Code noch im Documentation Trigger. Und Microsoft macht an uns deshalb auch keine Vorgaben.
GruĂź, Natalie

Frage beantwortet oder Problem von allein gelöst? Schreibe bitte [Gelöst] vor den Titel des ersten Beitrags.

Bitte erst suchen, dann fragen. Bitte beachte den kleinen Community-Knigge.
Kein Support per PN, Mail, IM oder Telefon! DafĂĽr ist dieses Forum da.
Benutzeravatar
Natalie
Moderator
Moderator
 
Beiträge: 9257
Registriert: 31. Oktober 2006 19:51
Bezug zu Microsoft Dynamics: Microsoft Partner
Microsoft Dynamics Produkt: Microsoft Dynamics NAV

Re: Eigenentwicklung dokumentieren

Beitragvon JoelMachado » 25. August 2017 09:34

Vielen Dank
JoelMachado
 
Beiträge: 5
Registriert: 19. Dezember 2016 14:42
Realer Name: Joel Machado
Arbeitsort: Leipzig
Bezug zu Microsoft Dynamics: SchĂĽler / Student
Microsoft Dynamics Produkt: Microsoft Dynamics NAV


ZurĂĽck zu NAV 2017

Wer ist online?

Mitglieder in diesem Forum: 0 Mitglieder und 1 Gast