Domanda

Sto scrivendo un manuale utente e sono giunto a una discussione con un collega. Lui dice che non posso usare la parola "tu" in qualsiasi parte del manuale. Ora mi ricordo qualcosa su questo a scuola, ma che non era per la scrittura di procedure. Inoltre, fare un po 'googling ho osservato che la maggior parte delle esercitazioni in cui utilizzando un sacco. Io preferirei usarlo, ma solo se questa è considerata buona pratica. cosa ne pensi?

È stato utile?

Soluzione

Alcune persone credono che i manuali devono essere scritti come se fossero articoli scientifici. Altri credono che la precisione tecnica e la leggibilità è più importante. Sono di questi ultimi di persuasione - l'uso "si" se si adatta con il tuo stile generale, ma essere coerenti nella vostra utilizzo - ho trovato i documenti che passa tra "voi" e "noi" sono irritanti (ed è un peccato, ho sia reso responsabile di me stesso).

Altri suggerimenti

Le alternative, che io sappia sono:

  • 'Si' (seconda persona singolare) - "Si dovrebbe mettere il piatto sul tavolo"
  • Imperativo - "Mettere il piatto sul tavolo"
  • 'Noi' (prima persona plurale) - "Dovremmo mettere il piatto sul tavolo"
  • 'L'utente' (terza persona singolare) - "L'utente deve mettere il piatto sul tavolo"
  • Passive - "La piastra dovrebbe essere messo sul tavolo"

Le mie preferenze sono:

  • io preferisco l'imperativo come modalità predefinita, perché è la più breve (almeno verbosità).
  • evito il passivo, e la prima persona plurale.
  • Io uso il pronome di seconda persona ( "tu") o un sostantivo terza persona (ad esempio, "l'amministratore di sistema") quando voglio un soggetto esplicito anziché l'imperativo.

Il che è più facile da capire?

  

Fare clic sul pulsante. Vedrete una finestra di dialogo in cui è possibile digitare il proprio nome.

o

  

L'azione del clic sul pulsante provoca la comparsa di una finestra di dialogo che permette la possibilità per l'utente di inserire il proprio nome.

La prima è molto più facile da afferrare. (Uso di "si" può a volte essere sciatto, ma che tende ad essere nei casi in cui viene utilizzato come sostituto di "uno", o "alcune persone", o "le persone in generale". Va bene usarlo in cui si sono in realtà riferendosi alla persona che legge il testo.)

  • Se vuole, si può evitare il si in stile scrivendo nell'area / Stile passivo imperativo. Puoi anche provare il 'noi' approccio, ma che potrebbe suonare un po 'infantile. Sei facendo niente di sbagliato con l'utilizzo di voi però.
  • Per evitare a scrivere nel si-stile, utilizzo il passivo / stile imperativo. Il abbiamo approccio potrebbe anche lavoro , anche se potrebbe sembrare un po 'infantile. Là c'è niente di sbagliato con l'utilizzo di voi però.
  • può evitare di scrivere in te in stile impiegando il passivo / imperativo stile. O potremmo usare il noi-approccio, anche se potrebbe sembrare un po 'infantile. Si potrebbe provare l'uno avvicinarsi, ma il rischio di sembrare rigido-labbro superiore e allontanare la lettore. non mente usando una volta in un po ', però.

Io stesso preferisco la seconda linea. Una serie di comandi è più facile da seguire poi una storia nella si-modulo.

Si dovrebbe scrivere spiegazioni degli in terza persona.

  

Il Java flussi modello è un classico esempio modello Decorator.

Si dovrebbe scrivere istruzioni in seconda persona, ma anche allora, non è ancora una buona idea per fare riferimento al lettore come "voi".

  

Creare un costruttore che può inizializzare list sulla base di una data lista di liste.

Ora, come ti sei sentito dopo ho rilasciato 2 comandi a te, mio ??lettore?

Scrittura tecnica far rispettare la regola di utilizzare solo il testo passiva. che significa evitare "tu" sarà una buona idea di rimanere nel lato sicuro. che è in base a come lo faccio personalmente.

I avrebbe fatto ciò che Google, Microsoft, Yahoo, ecc fare. Ecco una pagina di aiuto a caso da Google:

http://mail.google.com/support /bin/answer.py?hl=en&answer=8494

spettacoli che "voi" è in uso. È possibile verificare come Microsoft scrive il Manuale d'uso troppo.

Come nota a margine, non vorrei usare "io" o "noi".

Credo che se si sta fornendo imperativi, come ad esempio "Apri la porta", o in altro modo rivolgendosi direttamente al lettore, allora si dovrebbe uso "tu" invece di rendere se stessi più difficile da comprendere parlando su alcuni utenti astratto.

Anche in articoli scientifici, alcuni dei scrittura più formale mi viene in mente, è discutibile se o no I , che e altre lingue in prima persona è ammissibile. Per quanto gli insegnanti delle scuole superiori di grammatica avrebbe fatto piacere che tu pensi in caso contrario, non v'è universalmente schema appropriato.

Direi che basta stare attenti. Si potrebbe venire attraverso come troppo casual. Se il pubblico previsto è business-y, vorrei evitare di esso. Tuttavia, se si tratta di uno scenario utente domestico o il marketing è casuale (si pensi Southwest Airlines), direi andare con esso.

Proprio non lo fanno un uso eccessivo. Allora diventa la tassazione sul lettore.

Esempio di come è destinato ad essere utilizzato?

Tutto dipende il tono e lo stile della vostra scrittura. approcci formali scoraggiare l'uso del "voi". Personalmente, mi piace di utilizzare uno stile che è conciso, al punto e relativamente informali. Non ho alcun problema con il "tu" parola quando usato con parsimonia.

evitare un eccesso di utilizzo come in:

Quando si desidera avviare l'applicazione è necessario inserire la password e poi si deve selezionare la funzione che si desidera utilizzare.

Dal Manuale di Scrittura tecnica. 8 ° Edizione (p 262).

  

È possibile effettuare le frasi più brevi, lasciando fuori alcuni articoli (un, uno, l'), alcuni pronomi (voi, questo, questi), e alcuni verbi, ma queste frasi può provocare stile telegraphics ed essere più difficile da capire.

Quindi, io direi che è OK per utilizzare, ma come Gilbert Le Blanc ha detto nel suo commento, è spesso meglio scrivere 'quindi fare clic sul pulsante' invece di 'allora si fa clic sul pulsante'.

forma impersonale dovrebbe essere preferito. L'uso del 'tu' sarebbe troppo chiaro, e la maggior parte dei vostri clienti ti crederà non sono professionali. Un manuale chiaro ridurrà anche la necessità di assistenza post-vendita al cliente e le perdite causa per l'azienda.

Autorizzato sotto: CC-BY-SA insieme a attribuzione
Non affiliato a StackOverflow
scroll top