[OT] Standard per la stesura di documentazione tecnica

[IMMANUEL_KANT]

Ciao a tutti,
esiste uno standard formale, o informale, per la scrittura di documentazione tecnica?
Stessa cosa, per i manuali sull'utilizzo del software.

Grazie in anticipo.

[mirkoagrati]

Ciao IMMANUEL_KANT,
non ho capito bene,
però se ti riferisci a documentazione tipo i JavaDocs per java
puoi dare un'occhiata qui .

Ciao

[ivenuti]

in effetti non si capisce se ti riferisci ad uno standard tecnologico (e in quel caso esistono, come segnalato, JavaDocs, gli help di Windows etc) o "stilistico".
In quest'ultimo caso chiediti che tipo di documentazione vuoi scrivere. Esistono FAQS, how-to, tutorial, etc. Ciascuna con un proprio "stile" e taglio.

[IMMANUEL_KANT]

Ciao, grazie delle risposte.
Non mi riferisco ad uno standard tecnologico (interessante javadocs) ma proprio alle FAQS, how-to, tutorial, ecc. In relazione a queste chiedevo, appunto, se esistono delle linee guide o degli standard da rispettare o ognuno può far un po' come crede.

[MItaly]

Credo che ogni software house (specie se di dimensioni non indifferenti) abbia le sue linee guida interne.

[IMMANUEL_KANT]

Sicuramente.
E' anche vero però che l'ingegneria del software stabilisce metodi e tecniche generali per la produzione del software che vengono implementate a diversi livelli dalle software house.
Chiedevo se ce ne sono di generiche anche per questo tipo di documentazione

[moaiamorfo]

ciao, qui c'è qualche spunto/riferimento.

saluti