come possiamo migliorare la documentazione del progetto

Question

come possiamo migliorare la documentazione del progetto

#1 da (1 voti)
#2 da (1 voti)

1

Stiamo progettando di sviluppare un'API di database per il nostro progetto. Voglio sapere come possiamo migliorare la nostra documentazione.

La struttura corrente di un documento è:

Introduction :
Database Objects :List
Each Object (Table) Field List
List of Common Input Parameters.
loop of each command of database api
   Input Parameter of command 
   Output Parameter of command 
   Example of using the command 
End of loop

Si prega di suggerire se possiamo migliorare la nostra documentazione. :)

project-management requirements documentation

posta WebDev 22.01.2011 - 09:27

fonte

2 risposte

1

Stai cercando di documentare la struttura del database stesso o l'API che stai progettando di creare?

Se si tratta della documentazione API, cerca doxygen . È sicuramente un buon strumento da avere.

risposta data 22.01.2011 - 09:37

fonte

Leggi altre domande sui tag project-management requirements documentation

Immagine flessibile REST api con cdn e caching Uso ottimale di ibernazione con le stored procedure di mysql

score 1 · Accepted Answer

Guardando la struttura del tuo documento sembra che tu abbia bisogno di uno strumento di documentazione del codice come Doxygen, che eseguirà da solo la struttura che stai utilizzando. Può gestire paragrafi lunghi insieme a commenti API, come Javadoc,

Per scrivere la documentazione senza codice, come manuali e simili, c'è LaTex e DocBook. Non ho mai usato quest'ultimo, ma alcune persone fare. È basato su XML, hai bisogno di un editor XML e della distribuzione di DocBook da installare, insieme ai modelli per i tuoi documenti. Qui Le persone di GNOME danno alcune istruzioni su come iniziare. Potresti anche trovare i loro modelli utili per i tuoi progetti.

LaTex è invece più vecchia e utilizza il proprio linguaggio di markup, che tende ad essere meno prolisso di DocBook, ed è stato usato per molto tempo da molte persone, quindi hai un sacco di risorse. Controlla il Wikibook per questo, è abbastanza buono.