Wat in technische documentatie

[PdeHoog]

Ey,

Op dit moment zit ik bij een klant waar ik werk aan een VB-applicatie. De projectleider heeft het schrijven van de technische documentatie lekker in mijn schoenen geschoven () nadat degene die de gehele applicatie heeft ontworpen en ontwikkeld uit dienst is gegaan.

Ik vroeg me nu af hoe de medetweakers een applicatie zouden documenteren die zij niet door en door kennen, waar ze niet alle ontwerp-beslissingen kennen etc. etc. Misschien hebben jullie daar ideeen over (let wel: het is een soort van ERP-applicatie en zit dus vrij gecompliceerd in elkaar)?

Verder zit ik me ook al een dag af te vragen wat nu een goede opzet is voor de documentatie. Ik heb inmiddels het volgende bedacht:
- algemeen geblaat over applicatie (doelgroep, ontwikkelomgeving, systeemeisen etc. etc.)
- algemene ontwerp
- globaal overzicht procesgang
- detailoverzicht van de kritische punten
- overzicht afhankelijkheid tussen objecten (volgorde van form-aanroep e.d.)

Hebben jullie verder nog ideeen?

[akakiwi]

- Zorg ervoor dat je de meeste functies hebt uitgezocht, en dat je deze voorziet van pre en post condities.
Wat ik zelf ook altijd doe is een kleine beschrijving van de functie zelf, en binnen de functie zelf wat uitleg bij regels code die anders over 1 maand of zo niet meer te begrijpen zijn.
- Ik zorg ook altijd voor een schema waarin de relatie tussen de schermen onderling duidelijk wordt. Dan heb je meteen een programma flow.

Met jou items erbij is het dat wel zo'n beetje.

Succes

[Reptile209]

* Bestanden en dir's die door het programma gebruikt worden, zowel "eigen" spul als in de OS-omgeving
* locatie van de source
* lijst met medewerkers / externen die er mee bezig zijn geweest: altijd handig als die nog leven en de pl**ris uitbreekt

^{* Reptile209 probeert ook maar wat, HTH}

[Woudloper]

De interpretatie van de term Technische Specificatie is erg verschillend, aangezien het niveau ook vaak afhangt van mate in hoeverre de Functionele Specificaties al de techniek hebben beschreven....

Bij het huidige project waar ik op zit is het zo dat de functionele specificaties van het systeem óók al erg technisch zijn. Met als gevolg dat wij in de Technische Specificaties alleen het volgende opnemen:
High level

• Hardware en Sofware omgeving
• Systeem structuur
• Database overzicht
• Programma diagrammen (program flows)
• Subniveau's
  • Datamodel
  • Tabellen
  • (eventuele) tabelveranderingen
  • Welke statische data hebben we...
  • Welke packages bestaan er (worden er gecreeërd)
    Hier zit natuurlijk ook een beschrijving bij van de package en van de functies, procedures welke hierin zitten

Een hele lijst kan het dus worden, maar ik zou zeggen... Probeer het eens en kijk maar wat ze er van vinden

[PdeHoog]

OK. Bedankt voor alle reacties tot op heden. Ik ga er eens wat moois van kleien. Ik laat nog wel even weten wat er uiteindelijk allemaal in is gekomen.

[justmental]

module cross reference
versietabel
table/column usage documentatie

[Verwijderd]

KLOENK!

[PdeHoog]

Verwijderd schreef op 20 september 2002 @ 00:29:
KLOENK!

Link had ik al eens gevonden (ook in documentatie van school). Er wordt alleen met geen woord over de inhoud van de Technische Documentatie gerept. Het betreft hier alleen het basisontwerp en het detailontwerp.

Ik ben echt op zoek naar hoe een applicatie te documenteren.