 | 
|
 |  Code- und Design-Dokumentation
Für die Zusammenarbeit bei der Software-Entwicklung gibt es unterschiedlichste Modelle. Allen gemeinsam ist: Für eine effektive Zusammenarbeit müssen alle Entwickler den internen Aufbau der Software und die zur Verfügung stehenden APIs kennen. Darüber hinaus kann eine solche Dokumentation dazu genutzt werden, bei iterativen Entwicklungsprozessen den Fortschritt sowie ein korrektes gemeinsames Verständnis der umzusetzenden Arbeit im Auge zu behalten. Auf Wunsch erstellt und pflegt emlix solche Dokumentationen während des gesamten Projektverlaufes. Dabei wird das Dokumentenformat sowie der Aufbau der Dokumentation in Absprache mit unseren Kunden festgelegt.  Design-Dokumentation
Das Ziel einer Design-Dokumentation ist es, die Umsetzung der Lösung auf recht abstraktem Niveau zu beschreiben, ohne auf technische Details der Implementierung im Detail einzugehen. Für die Applikationsentwicklung heißt dies zum Beispiel, dass die Struktur der Software (Aufteilung in einzelne Komponenten) beschrieben wird, wobei die Funktionen und das Zusammenspiel einzelner Komponenten thematisiert werden. Ein Designdokument richtet sich nicht nur an Entwickler, sondern ausdrücklich auch an Nicht-Programmierer. Die besondere Form eines Design-Dokuments macht es möglich, durch einfaches Durchdenken verschiedener Use Cases die korrekte Konzeption der Lösung zu validieren. Eine solche Design-Dokumentation kann im Rahmen von Consultingleistungen erstellt werden, aber auch integraler Bestandteil eines Entwicklungsauftrags sein.  Code-Dokumentation
Für eine Zusammenarbeit bei der Entwicklung oder der weiteren Produktpflege sind Erweiterungen oder Änderungen am Code notwendig. Dies kann nur sinnvoll geschehen, wenn der zugrunde liegende Quelltext ausreichend dokumentiert ist. Das beinhaltet sowohl die API-Dokumentation als auch die technische Beschreibung der Implementierung der Konzepte, die in der Design-Dokumentation vorgestellt wurden. Hierbei hat es sich für die Pflege der Dokumentation als hilfreich erwiesen, sie in den Quelltext zu integrieren von entsprechenden Programmen extrahieren und als verlinkte HTML-Seiten aufbereiten zu lassen. Dadurch ist gewährleistet, dass die Dokumentation stets synchron mit Codeänderungen gehalten werden kann. 
|
 | 
|
 |