Documentazione esterna

[gd020188]

Salve a tutti.

Se si ha da presentare un programma che si compone di:

• un programma chiamante che ha il compito di:
- leggere i dati di input;
- controllare che i dati di input di cui sopra rispettino i limiti imposti sulle variabili che li devono memorizzare;
- chiamare due subroutine per eseguire le operazioni sui dati di input che poi daranno come risultato i dati di output che sono lo scopo del programma;
- visualizzare i dati di output.

• due subroutine;

la documentazione esterna deve essere riferita alle sole due subroutine e si deve utilizzare il codice del programma chiamante solo per illustrare un esempio di (per l'appunto) programma chiamante, oppure la documentazione esterna deve riferirsi anche al programma chiamante?

So che la domanda andrebbe posta a chi commissiona il lavoro, ma non c'è qualcuno che abbia commissionato il lavoro, in questo caso. Trattasi di mia curiosità perché googlando ho trovato o esempi di documentazioni delle sole subroutine, oppure documentazioni di programmi interi che non fanno uso di subroutine.

Grazie.

[wingman87]

Qual è lo scopo per cui scrivi la documentazione? E' in base a questo che decidi cosa documentare.