In modo da capire il vostro progetto documentazione per l'utente e l'hai speccato fuori. Ora siete pronti a scrivere. Ecco alcuni consigli per aiutarvi nel vostro cammino. Questo articolo non riguarda la scrittura vera e propria, si tratta di cose che vanno insieme con la scrittura. (Per informazioni sulla scrittura on line, vedere http://www.divinewrite.com/helpfulhelp.htm.)
NOTA: Questo è l'articolo finale in una serie di tre che delinea gli elementi chiave di un buon processo di documentazione per l'utente. (Per leggere gli articoli prima e la seconda di questa serie, vai http://www.divinewrite.com/docoprocess1.htm e http://www.divinewrite.com/docoprocess2.htm.)
Indicizzazione
Parole chiave indice dovrebbe essere definito, mentre il tema è stato scritto. In questo momento, l'oggetto è chiaro nella mente dell'autore, e sono molto dimestichezza con tutti i dettagli intricati. Indicizzazione durante la fase di scrittura significa anche che le parole chiave sono esaminate come parte del processo di progetto.
Alcuni strumenti di authoring in realtà non facilitano questo tipo di approccio particolarmente bene (ad esempio, alcuni non consentono l'accesso multiplo autore ai file necessari per l'indicizzazione), ma almeno le parole chiave devono essere elencati alla fine di ogni progetto. (A seconda dello strumento di authoring, questo può effettivamente essere più facile per i revisori, comunque.) SUGGERIMENTO: Per maggiori informazioni su indicizzazione, vedere L'arte di indicizzazione (1994) di Bonura.
Documentazione per l'utente su
Per assicurarsi che la documentazione per l'utente è tecnicamente corretto e leggibile, è necessario per ottenere la recensione di una selezione intelligente di persone. Per un progetto di software, la tua lista revisione dovrebbe includere un esperto di oggetto (in genere il programmatore), l'architetto del software, forse il responsabile del progetto, e un altro scrittore. I requisiti di revisione varia ad ogni progetto, per cui i revisori e le procedure devono essere documentate nel vostro pracs lavoro.
Verifica della documentazione per l'utente
I test possono essere effettuati in un certo numero di livelli:
• Ogni scrittore dovrebbe testare la propria documentazione utente, seguendo per l'utilizzo del prodotto. Ma ricordate, questo tipo di test non è molto potente, perché c'è una tendenza per gli scrittori di attenersi alle istruzioni pensano di averli scritti, non come hanno fatto loro scritti.
• Il secondo livello è per il test deve essere eseguito da altri scrittori ... come parte della revisione tra pari.
• Il terzo livello è per il reparto test per fare dei test formale sulla documentazione per l'utente. Questo tipo di test non capita spesso, ma è bene cercare di farlo accadere.
• Il quarto livello è / deve essere condotta come parte del beta testing (si veda Gestione dei Progetti Documentazione da Hackos (1994), pp.452-453).
Verifica della documentazione per l'utente
I test possono essere effettuati in un certo numero di livelli:
• Ogni scrittore dovrebbe testare la propria documentazione utente, seguendo per l'utilizzo del prodotto. Ma ricordate, questo tipo di test non è molto potente, perché c'è una tendenza per gli scrittori di attenersi alle istruzioni pensano di averli scritti, non come hanno fatto loro scritti.
• Il secondo livello è per il test deve essere eseguito da altri scrittori ... come parte della revisione tra pari.
• Il terzo livello è per il reparto test per fare dei test formale sulla documentazione per l'utente. Questo tipo di test non capita spesso, ma è bene cercare di farlo accadere.
• Il quarto livello è / deve essere condotta come parte del beta testing (si veda Gestione dei Progetti Documentazione da Hackos (1994), pp.452-453).
Non importa quale livello di test utilizzato, deve essere progettato per assicurare che i compiti documentati sono vere al prodotto, e che tutte le funzioni di guida in linea in modo corretto. Per la documentazione per l'utente di passare di prova, deve soddisfare gli obiettivi specificati nelle prime fasi del progetto.
Localizzando la documentazione utente
Anche se la localizzazione è spesso considerato un post-scrittura di attività, è meglio farlo come parte della fase di scrittura. L'esatta tempistica può variare in progetto a progetto, ma una buona regola è quella di ottenere la traduttori che lavorano sui progetti secondo (ma solo se non ci aspettiamo molti cambiamenti al progetto). SUGGERIMENTO: La maggior parte dei traduttori probabilmente preferiscono lavorare su un pezzo considerevole di documentazione per l'utente, piuttosto che singoli argomenti inviato loro frammentario, così si dovrebbe aspettare 'til avete qualcosa di dimensioni rispettabili di inviare loro - forse un argomento intero , al contrario di un singolo argomento.
Con la localizzazione, si sta eseguendo un atto d'equilibratura. Se si invia la documentazione utente per i traduttori troppo presto, si spenderà un sacco di soldi sulle modifiche alle traduzioni. Se lo si invia troppo tardi, non sarà pronto in tempo per il rilascio del prodotto.
Gestire il cambiamento
E 'importante che minimizzare l'impatto delle modifiche al prodotto e / o pianificare lo sviluppo. Per fare questo, è necessario sviluppare una tecnica che:
1. Identifica il cambiamento
2. Stima l'impatto nel tempo e / o risorse *
3. Informa il responsabile del progetto
* È possibile utilizzare le stesse tecniche di stima che hai utilizzato in precedenza nel progetto.
appening.• Il quarto livello è / deve essere condotta come parte del beta testing (si veda Gestione dei Progetti Documentazione da Hackos (1994), pp.452-453).
Non importa quale livello di test utilizzato, deve essere progettato per assicurare che i compiti documentati sono vere al prodotto, e che tutte le funzioni di guida in linea in modo corretto. Per la documentazione per l'utente di passare di prova, deve soddisfare gli obiettivi specificati nelle prime fasi del progetto.
Localizzando la documentazione utente
Anche se la localizzazione è spesso considerato un post-scrittura di attività, è meglio farlo come parte della fase di scrittura. L'esatta tempistica può variare in progetto a progetto, ma una buona regola è quella di ottenere la traduttori che lavorano sui progetti secondo (ma solo se non ci aspettiamo molti cambiamenti al progetto). SUGGERIMENTO: La maggior parte dei traduttori probabilmente preferiscono lavorare su un pezzo considerevole di documentazione per l'utente, piuttosto che singoli argomenti inviato loro frammentario, così si dovrebbe aspettare 'til avete qualcosa di dimensioni rispettabili di inviare loro - forse un argomento intero , al contrario di un singolo argomento.
Con la localizzazione, si sta eseguendo un atto d'equilibratura. Se si invia la documentazione utente per i traduttori troppo presto, si spenderà un sacco di soldi sulle modifiche alle traduzioni. Se lo si invia troppo tardi, non sarà pronto in tempo per il rilascio del prodotto.
Gestire il cambiamento
E 'importante che minimizzare l'impatto delle modifiche al prodotto e / o pianificare lo sviluppo. Per fare questo, è necessario sviluppare una tecnica che:
1. Identifica il cambiamento
2. Stima l'impatto nel tempo e / o risorse *
3. Informa il responsabile del progetto
* È possibile utilizzare le stesse tecniche di stima che hai utilizzato in precedenza nel progetto.
Scrittura tracciare i progressi ottenuti
E 'importante notare che la fase di scrittura non è semplicemente di scrivere. Se si traccia dei tuoi progressi ad ogni passo lungo la strada, sarete in grado di vedere se soddisferà le vostre tappe e scadenze, e sarete anche in grado di utilizzare questo progetto come una esperienza di apprendimento ... per pianificare meglio la prossima . (È necessario assicurarsi che tutti i record di progetto sono facilmente accessibili per la manutenzione in corso e future di riferimento del progetto.)
Si consiglia di tenere traccia del tempo impiegato per eseguire ogni passo descritto in questa procedura così come ogni fase di progetto, i tempi di revisione, i tempi di consegna totale, ecc
Condurre riunioni di team regolari
Al fine di tenere informati tutti i membri del team di scrivere progresso, si dovrebbe condurre riunioni di team regolari. Questi incontri dovrebbero essere un forum per dare un'occhiata al vostro inseguimento metriche e discutere la percentuale stimata completa per i vari argomenti attualmente in corso. Se la percentuale stimata completo è inferiore a quello che dovrebbe essere dato il tempo già trascorso, allora si può agire su di esso. Questi incontri consentono di identificare intoppi nel corso di scrittura.
No comments:
Post a Comment