Editor per la fine di documentazione per l'utente in C # WinForm app

Question

Sto sviluppando un'applicazione WinForm in C # 4.0 e vorrei altri (non-sviluppatore) colleghi per contribuire a scrivere un sensibile al contesto fileguida utente finale. Per prima cosa ho pensato che avrei potuto usare "HTML Help Workshop" di Microsoft, ma sembra antiquato (Vista e Windows 7 non sono supportati). Poi ho guardato Castello di sabbia, ma la documentazione è carente e mi chiedo se è adatto per gli utenti non tecnici alla documentazione di scrittura per l'utente finale. Così ho letto di RoboHelp, ma è modo costoso per me. Mi sto perso in tutte le informazioni che sono disponibili su helpfiles. Qualcuno può contribuire a dare alcune best practice o le informazioni su quali strumenti utilizzare e quale formato di output che devono avere come obiettivo (ancora chm o altro).

Answer 1

Grande questione. Mi piace la tua idea di non-sviluppatori che contribuiscono alla documentazione per l'utente finale.

Questa idea potrebbe utenti motivare e tester della vostra applicazione in modo semplice contribuire alla documentazione.

La prima cosa che mi viene in mente, sta usando una sorta di motore wiki. Si potrebbe costruire una semplice funzione nell'applicazione WinForm, che spara un browser e dirige per il wiki. È possibile utilizzare il contesto da cui è chiamata a costruire un URL; per esempio. http://dev-wiki.mycompany.com/LoginForm?action=edit. Ecco il nome del modulo ( "LoginForm") è utilizzato nella URL di una pagina wiki.

In alternativa, si può semplicemente utilizzare il rel="nofollow"> web browser incorporato per il controllo WinForms per accedere al wiki. Sarebbe qualcosa di simile:

var url = GetWikiUrl(myForm);
browserControl.Navigate(url);

Questo sarebbe molto facile da incorporare nella vostra applicazione.

In un ambiente controllato (ufficio), questo sarebbe molto facile da configurare. In te ambiente di produzione che potrebbe essere un po 'più difficile, ma ancora fattibile. Si potrebbe sfruttare alcuni contributi degli utenti finali anche.

Answer 2

Per la scrittura di documentazione, io uso sfinge . Esso consente di documentare in testo normale e ha vari formati di output (CHM, HTML, PDF, ecc.).

Alcuni di questi (chm, html) possono essere usati come fonti di informazioni sensibili al contesto.

Comunque semplice, l'interfaccia utente sfinge (editor di testo e file di make) potrebbe non essere adatto per gli utenti non tecnici.

Answer 3

mi sento di raccomandare di utilizzare Help + Manual per la creazione di documentazione CHM. E 'simile a MS Word e qualsiasi utente di PC può iniziare a contribuire allo sviluppo doc dopo la scuola breve. Ma questo strumento non è gratuito: (