Consigli per un sistema di guida basato sul web

4

Sto mettendo insieme una GUI abbastanza grande. Sono un tecnico, ma più dal lato hardware, non dal software. Mi chiedo quale pacchetto software sarebbe più adatto per permettermi di generare un sistema di guida basato sul web. Preferibilmente si occupa di molto codice, permettendomi di concentrarmi sul contenuto.

Ad esempio, l'utente farebbe clic su un collegamento nella GUI quando hanno una domanda, che li porta a una Guida in linea basata sul Web, ad esempio, fornendo una panoramica su come utilizzare la GUI, forse un indice ricercabile (indice basato su parole chiave), sommario, ecc. per navigare nella Guida.

Il mio primo pensiero è stato quello di programmare tutto in XHTML usando Dreamweaver, ma i miei requisiti di layout sono abbastanza modesti (solo figure e testo, forse qualche equazione), e preferirei non dedicare molto tempo alla programmazione . Mi chiedevo se esistesse qualche software che rendesse facile la creazione / pubblicazione di pagine navigabili basate sul web. Ancora una volta, non sono un programmatore, quindi se c'è qualcosa di ovvio là fuori, probabilmente non ne sono a conoscenza.

    
posta gkdsp 15.02.2011 - 05:01
fonte

2 risposte

6

Sphinx (http://sphinx.pocoo.org/) è uno di questi sistemi. È stato scritto per la documentazione ufficiale di Python ma, a differenza di molti strumenti per fornire documentazione API, non si basa su markup incorporato nel codice del programma. Usa semplicemente una semplice sintassi di markup in file di testo e può elaborare quei file marcati in HTML / PDF, ecc. Il sito web sfinge lo stesso (per lo più?) Un progetto sfinge in modo da poter vedere quale tipo di output si ottiene. Tuttavia, la sfinge è abbastanza a tema in modo da poter personalizzare l'aspetto (o semplicemente mettere il logo della tua azienda sull'intestazione se è tutto ciò che serve.)

    
risposta data 15.02.2011 - 06:04
fonte
3

MadCap Flare è un ottimo strumento per l'authoring della guida. Il mio team l'ha usato per fornire un aiuto basato sul contesto per un sistema piuttosto grande e gli scrittori tecnologici non potevano smettere di parlare di quanto lo amassero.

    
risposta data 15.02.2011 - 06:07
fonte

Leggi altre domande sui tag