Come costruire e fornire la documentazione per gli strumenti informatici su Windows? [chiuso]

Question

Come faccio a costruire e fornire la documentazione per uno strumento informatico su Windows? C'è un ulteriore vincolo che io non voglio spendere soldi per strumenti di authoring di aiuto.

Qui su SO, si parla di algoritmi e ottimizzazioni, API e prestazioni. Ma uno dei risultati dai miei sforzi dev è la documentazione. Qual è il modo migliore per costruire, e in quale forma devo consegnarlo?

Se sto offrendo un set di API .NET, un .CHM è un meccanismo ragionevole per la consegna. E 'molto facile da usare SHFB per costruire il file di aiuto come parte della costruzione, e se sarà utilizzato per lo più su Windows, un .CHM è molto accessibile. E convertendo il .CHM al .HTM rende il doc accessibile anche in senso più ampio.

Ma voglio fornire doc per un filtro ISAPI che sarà utilizzato dagli sviluppatori, non per sé, ma per gli amministratori di server Web di Windows. Ho bisogno di descrivere l'installazione, le operazioni e la configurazione. Penso che gli utenti finali possono spesso hanno sviluppatore, nonché le competenze amministrative, ma in ogni caso, per i miei scopi della documentazione coprirò le attività amministrative e questioni operative.

So che SHFB mi permette di includere i file HTML regolari nella CHM. Se so già SHFB, e se io non voglio spendere soldi per uno strumento di aiuto-authoring, è questo il modo migliore per andare? Se no, che cosa?

Answer 1

Alla fine, ho deciso di utilizzare Sandcastle file di aiuto Builder, il tool gratuito disponibile su http: //shfb.codeplex .com . Ho già usato castello di sabbia per costruire il documento di riferimento per un progetto diverso, quindi sapevo qualcosa sullo strumento. Produce CHM o .HxS file, adatto per l'utilizzo su Windows. Non avevo mai usato SHFB di "progettare" un helpfule prima, ma era abbastanza facile da capire come farlo. I risultati sono molto buoni.

Answer 2

Texlipse è un plugin per Eclipse lattice. Entrambi sono liberi. Latex viene utilizzato da molti ricercatori per generare i loro documenti ed è anche usato per molti libri di testo. Si tratta di uno strumento gratuito che potrebbe soddisfare le vostre esigenze.

Answer 3

asciidoc . Non è LaTeX, ma produce bel PDF / CHM / HTML e si può insegnare a non-programmatore di scrivere la documentazione per voi, che è un bel bonus:)

Answer 4

Perché non scrivere la documentazione in ufficio aperto e poi esportarlo in PDF?

Il lattice è il modo professionale, ma non è rapidamente accessibile.