Dokumentation

[timmiboy]

Hallo,

ich soll ein Dokumenation machen über ein Thema. Ich habe kein Plan wie ich das angehen soll.

Kann mir einer sagen, wie die aussehen muss bzw. was da rein muss.

Vtl. gibt es ja ne Vorlage.

Wäre euch dankbar, wenn mir einer hilft.

[mezzomix]

Themen kann man nicht dokumentieren, nur Objekte kann man dokumentieren. Daher ist deine Frage etwas schwierig zu beantworten.

Um was für ein Thema handelt es sich denn, oder ist das geheim?

[timmiboy]

Ist geheim, darf ja keiner wissen.

Hat was mit Computern zu tun.

[mezzomix]

Naja, es gibt verschiedene Arten von Dokumentationen.

Wie etwas funktioniert.

Wie man etwas benutzt.

Wie man etwas repariert.

Also ich kann mir beim besten Willen nicht vorstellen, wie man bei so einem umfassenden Thema wie Dokumentationen ernsthaft nach einer Vorlage fragen kann. Das wäre wie nach einer Anleitung zum glücklichsein zu fragen.

Sie dir dein Thema an. Welches Ziel hat es? Welche Zielgruppe hat es? Dann geh logisch und schrittweise vor. Schuhe anziehen, dann zubinden. Nicht andersherum. (Ich weiß, es geht auch mit zubinden zuerst ... mache ich auch )

[timmiboy]

Das haben wir gekriegt

Hinweise zur Dokumentation

Gesamtgestaltung Inhalt Deckblatt

15 Gliederung

bestätigtes Thema

Quellenverzeichnis

Selbständigkeitserklärung

Anlagen

Form Gesamteindruck

Rechtschreibung, Grammatik

Einbindung von Grafiken, Darstellungen, Diagrammen, Tabellen

Auftragsbeschreibung Erläuterung und Präzisierung der Aufgabenstellung

10 Beschreibung der Rahmenbedingungen, Kundensituation

Beschreibung des Lösungsansatzes

Beschreibung der Eigenleistung

Abgrenzung von Fremdleistungen

Durchführung Ist-Analyse

40 Soll-Analyse

Erarbeitung von Lösungswegen

Entscheidungen und Begründungen

Darstellung der Umsetzung

Tests und Maßnahmen zur Qualitätssicherung

Ergebnisse begründete Abrechnung der Aufgabenstellung (entsprechend des bestätigten Themas)

20 Soll- Ist- Vergleich

Beschreibung und Begründung von Abweichungen

Projekttypische Kundenunterlagen Übergabeprotokoll

15 Testprotokoll

Entwurfswerkzeuge (Struktogramm, ER-Diagramm, Rechtepläne, ...)

Kurzanleitungen

[mezzomix]

Die Liste ist doch super!!!

Geht es überhaupt um die Abschlussprüfung?

[timmiboy]

Ne, ist ein Projekt.

Weiss aber nicht, wie ich die Doku machen soll.

[mezzomix]

Ich benutze jetzt einfach mal die super Liste von oben:

1. bestätigtes Thema

2. Gliederung

3. Auftragsbeschreibung Erläuterung und Präzisierung der Aufgabenstellung

4. Beschreibung der Rahmenbedingungen, Kundensituation

5. Beschreibung des Lösungsansatzes

6. Beschreibung der Eigenleistung

7. Abgrenzung von Fremdleistungen

8. Durchführung Ist-Analyse

9. Soll-Analyse

10. Erarbeitung von Lösungswegen

11. Entscheidungen und Begründungen

12. Darstellung der Umsetzung

13. Tests und Maßnahmen zur Qualitätssicherung

usw ...

Quellenverzeichnis

Selbständigkeitserklärung

Anlagen

Form Gesamteindruck

Rechtschreibung, Grammatik

Einbindung von Grafiken, Darstellungen, Diagrammen, Tabellen

Um was geht es in deinem Thema?

Einleitung, umreiße das Thema!

Ohne zu wissen, um was es geht ist es schwierig dir zu helfen.

Abgesehen davon glaube ich du bist ein wenig faul und denkst, jemand hier wird dir schon alles vorkauen. Du antwortest auf jede Frage mit 2-3 Sätzen ohne irgendwie mit mehr Details herauszurücken, oder uns überhaupt zu zeigen, dass du dich mit dem Thema Doku schon auseinandergesetzt hast. Statt dessen klatschst du uns hier eine lange liste hin, die du eben mal so bekommen hast.

Zeig ein wenig Engagement, sonst bin ich jedenfalls raus.

[timmiboy]

Nein, ich bin nicht faul, ich möchte gerne bloß ein Besipiel haben.

[flashpixx]

... ich möchte gerne bloß ein Besipiel haben.

Du möchtest Dich hier im Forum nach fertigen Dokumentationen von FIAE/FISI Abschlussarbeiten umsehen.

[timmiboy]

Nein, ich will ein Beispiel.

Weiss ich doch nicht, was damot gemeint ist und wie ich das umsetzen muss:

3. Auftragsbeschreibung Erläuterung und Präzisierung der Aufgabenstellung

4. Beschreibung der Rahmenbedingungen, Kundensituation

5. Beschreibung des Lösungsansatzes

6. Beschreibung der Eigenleistung

7. Abgrenzung von Fremdleistungen

[mezzomix]

Nein, ich will ein Beispiel.

Weiss ich doch nicht, was damot gemeint ist und wie ich das umsetzen muss:

3. Auftragsbeschreibung Erläuterung und Präzisierung der Aufgabenstellung

4. Beschreibung der Rahmenbedingungen, Kundensituation

5. Beschreibung des Lösungsansatzes

6. Beschreibung der Eigenleistung

7. Abgrenzung von Fremdleistungen

Frage: 5. Beschreibung des Lösungsansatzes

Antwort: "Zunächst muss im Forum gefragt werden, was eine Dokumentation ist. Sobald eine Antwort eingetroffen ist, beginne ich mit …"

Frage: 6. Beschreibung der Eigenleistung

Antwort: "Ich habe hier im Forum nach eine Dokumentation gefragt."

Ist das jetzt so schwer? Frag doch mal deine Kollegen, was du tun sollst. Die wissen wenigstens, um was es geht.