El uso de la palabra “que” en un manual de usuario [cerrada]

Question

Estoy escribiendo un manual de usuario y he llegado a una discusión con un colega. Él dice que no puedo usar la palabra "que" en cualquier parte del manual. Ahora recuerdo algo acerca de esto en la escuela pero que no era para los procedimientos de escritura. Además, haciendo algunos que googlear observado que la mayoría de tutoriales donde lo utilizan mucho. Yo preferiría usarlo pero sólo si esto se considera una buena práctica. ¿qué te parece?

Answer 1

Algunas personas creen que los manuales deben ser escritos como si fueran artículos científicos. Otros creen que la precisión técnica y la legibilidad es más importante. Soy de la última persuasión - uso "que" si se ajusta a su estilo en general, pero sea constante en su uso - Me encontrar documentos que cambia entre "usted" y "nosotros" son irritantes (y es un pecado que he culpable de mi mismo).

Answer 2

Las alternativas que conozco son:

• 'Usted' (segunda persona del singular) - "Usted debe poner la placa en la tabla"
• imperativo - "Ponga la placa sobre la mesa"
• 'Nosotros' (primera persona del plural) - "Debemos poner el plato en la mesa"
• 'El usuario' (tercera persona singular) - "El usuario debe poner el plato en la mesa"
• Pasiva - "La placa se debe poner sobre la mesa"

Mis preferencias son:

• Yo prefiero el imperativo como el modo por defecto, porque es la más breve (menos verborrea).
• evito la pasiva, y la primera persona plural.
• utilizo el pronombre segunda persona ( "usted") o una tercera persona sustantivo (por ejemplo, "el administrador del sistema") cuando quiero un sujeto explícito en lugar del imperativo.

Answer 3

Lo que es más fácil de entender?

Haga clic en el botón. Verá un cuadro de diálogo en el que puede escribir el nombre.

o

La acción de hacer clic en el botón hará que la aparición de un cuadro de diálogo que permite la posibilidad de que el usuario introduzca su nombre.

La primera es mucho más fácil de entender. (El uso de "usted" a veces puede ser descuidado, pero que tiende a ser en los casos donde se utiliza como sustituto de "uno" o "algunas personas", o "la gente en general". Bien sea para utilizarlo en el que esté en referencia a la persona que lee el texto.)

Answer 4

• Si que desee, puede evitar la que estilo al escribir en el / Estilo pasivo imperativo. Usted puede También probar el enfoque de 'nosotros', pero eso Puede sonar un poco infantil. estás no hacer nada malo con el uso que usted sin embargo.
• Para evitar escribiendo en el que de estilo, uso el pasivo / estilo imperativo. los nos-enfoque podría también trabajo , aunque Puede sonar un poco infantil. Ahí no es nada malo con el uso que usted sin embargo.
• puede evitar escribir en el que al estilo mediante el empleo de la pasiva / imperativo estilo. O podríamos utilizar el nos-enfoque, a pesar de que puede sonar un infantil bits. Se podría probar el uno acercarse, pero el riesgo de sonar rígido-labio superior y alienar la lector. no les importa usar una vez desde hace tiempo, sin embargo.

Yo mismo prefiero la segunda línea. Una serie de comandos es más fácil seguir a continuación, una historia en la que forma.

Answer 5

Se debe escribir simples explicaciones en tercera persona.

El Java arroyos modelo es un ejemplo clásico patrón de decorador.

Se debe escribir las instrucciones en la segunda persona, pero aún así, todavía no es una buena idea para referirse al lector como "usted".

Crear un constructor que se puede inicializar listas basado en una lista dada de listas.

Ahora, ¿cómo se sintió después de expedida el 2 de comandos para usted, mi lector?

Answer 6

Escritura técnica cumplir la regla de usar sólo texto pasiva. esto es, evitar "que" va a ser una buena idea para permanecer en el lado seguro. que está basado en cómo lo hago personalmente.

Answer 7

Yo haría lo que Google, Microsoft, Yahoo, etc hacer. Aquí hay una página de ayuda azar de Google:

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

muestra que "usted" se está utilizando. Puede comprobar cómo Microsoft escribe su manual del usuario también.

Como nota al margen, yo no usar "yo" o "nosotros".

Answer 8

Creo que si usted está proporcionando imperativos, tales como "Abrir la puerta", o de otra manera hacer frente directamente al lector, a continuación, debe uso "que" en lugar de hacerte más difícil de comprender por hablar sobre algunas de usuario abstracto.

Incluso en trabajos científicos, algunos de los escritos más formales que se me ocurre, es discutible si o no I , que y el otro primer idioma persona es permisible. Por mucho que los profesores de gramática de la escuela secundaria les gustaría a pensar de otro modo, no hay universalmente esquema apropiado.

Answer 9

Yo diría que sólo tenga cuidado. Podría parecer como demasiado informal. Si el público objetivo son los negocios-y, evitaría la misma. Sin embargo, si se trata de un escenario de usuario doméstico o la comercialización es informal (piensa Southwest Airlines), yo diría que ir con él.

Simplemente no hacer uso excesivo. Entonces se vuelve agotador para el lector.

Ejemplo de cómo es la intención de ser usado?

Answer 10

Todo depende del tono y el estilo de su escritura. enfoques formales desalientan el uso de "usted". En lo personal, me gusta utilizar un estilo que es conciso, hasta el punto y relativamente informal. No tengo ningún problema con el "tú" palabra cuando se usa con moderación.

Evitar el exceso de uso como en:

Cuando se desea iniciar la aplicación que tenga que introducir su contraseña y luego hay que seleccionar la función que desea utilizar.

Answer 11

Desde el Manual de escritura técnica. 8ª Edición (p 262).

Se puede hacer frases más cortas, dejando fuera algunos artículos (un, una, el), algunos pronombres (usted, esto, éstos), y algunos verbos, pero este tipo de frases puede resultar en estilo Telegraphics y ser más difícil de entender.

Por lo tanto, yo diría que está bien usar, pero como dijo Gilbert Le Blanc en su comentario, a menudo es mejor escribir 'haga clic en el botón' en lugar de 'continuación, hacer clic en el botón'.

Answer 12

forma impersonal debe preferirse. El uso de 'usted' sería demasiado clara, y la mayoría de sus clientes van a creer que no es profesional. Un manual claro también reducirá la necesidad de apoyo post-venta al cliente, y causan pérdidas a la empresa.