¿Cuáles son los dos conceptos básicos de la escritura técnica?

Answer 1

La redacción técnica PODRÍA ahorrar a muchas compañías Millones de dólares en la creación de productos fáciles de usar, clientes satisfechos, sitios web fáciles de entender, demandas judiciales disminuidas. —VS— tener que contratar abogados caros para demandas, juicios multimillonarios, firmas de relaciones públicas costosas para intentar atraer a los clientes con vagas e inútiles “Happy” tonterías para comerciales y sitios web, guías de productos.

1. PERO: NO entre en ESCRITURA TÉCNICA , ya que trabajará MÁS DIFÍCILMENTE que cualquier ingeniero, contador, arquitecto, dba o enfermero, pero tendrá MUCHA menos estabilidad laboral. Mucho menos. Y es un trabajo INCREÍBLE, bajo estatus, último contratado, primero despedido.
1. Vaya a cualquier otra cosa que no se pueda subcontratar: corte de cabello, electricidad, plomería, remodelación del hogar, carros de comida, guarderías para perros, atención médica, etc.
2. La redacción técnica solía ser una carrera estable antes de que los contadores de MBA se hicieran cargo de la alta tecnología, ahora TODOS los trabajadores son subcontratables, intercambiables y prescindibles, y la contratación se envía al mejor postor. Luego, las empresas se ENCUENTRAN ABSOLUTAMENTE cuando su material intelectual se filtra por todo el mundo cuando continuamente dejan a sus últimos trabajadores extranjeros por otros más baratos en un país extranjero en competencia. (Todas las clases de las últimas tecnologías NO te salvarán, todos los que conozco lo han intentado y terminaron siendo despedidos, especialmente después de los 40 años. Nadie puede competir contra países offshore que se perjudican entre sí en las tasas de hambre).
3. NINGUNA empresa en la que he trabajado realiza pruebas de habilidades basadas en la ciencia o mediciones de productividad basadas en la ciencia. El 99% de la gestión de los empleados se basa en el chisme, la opinión y la “clasificación y calificación” (lo que obliga a los compañeros de equipo a competir entre sí, PERO no hay pruebas basadas en habilidades o mediciones de productividad basadas en la ciencia, por lo que es realmente bueno) old-boys-club (amiguismo) y despidos basados ​​en chismes). Las empresas “intentan” administrar a los empleados con estimaciones de conjeturas en una hoja de cálculo o en un formulario web, pero eso sigue siendo increíblemente no científico.
1. Si hubiera pruebas de habilidades basadas en la ciencia y mediciones de desempeño laboral, habría despidos masivos de compinches / compinches no productivos, probablemente al menos el 70% del personal actual sería despedido , y esto abriría todos los campos para el mérito contrataciones
4. ESCRITORES TÉCNICOS FALSOS: Sin la prueba, es muy fácil FALSIFICAR ser un escritor técnico, contador, ingeniero, DBA de Oracle, etc. Lo he visto suceder, y he tenido que “ENTRENAR” a un escritor FALSO, porque nuestros jefes no quería admitir que no hicieron la prueba. Él llevaría las cosas a casa con su esposa para que las editara, pero también trataría de manipular a cada uno de nosotros, los diferentes trabajadores, para que lo “ayudaran” / hicieran todas las diferentes partes del trabajo.
2. Si eres un ingeniero que piensa hacerlo, serás etiquetado como ” secretario ” o ” débil “, definitivamente es un asesino profesional. Es mejor cambiar departamentos o empresas.
3. Conceptos básicos de redacción técnica:
1. Escribe sobre un proceso lo más completamente posible. Use un inglés muy simple, directo y no pomposo, elimine la palabrería adicional que no contribuye directamente al significado. Por lo general, estos documentos se leerán en una emergencia a las 2 am. NADIE en una emergencia a las 2 am quiere leer palabras de 10 sílabas o leer 10 páginas de tonterías para encontrar solo 1 pulgada de contenido significativo.
2. Pruebe y vuelva a probar la información regularmente. Encuentre todo tipo de personas no técnicas para leer el documento y siéntese con ellos mientras lo hacen. Si encuentran un problema, escríbalo y edite el documento para que quede más claro. Consulte los foros de la mesa de ayuda sobre el tema y busque problemas frecuentes de los clientes. Prueba de nuevo.
3. Publique los documentos en su intranet de trabajo o internet.
4. Cree y consolide todos los documentos técnicos en su intranet, y también cree una copia de seguridad en papel para dar a la administración para que puedan demostrar que entienden lo que está sucediendo con el negocio. Muchos inversores capitalistas de riesgo, miembros de la junta y auditores exigirán (o deberían) esta información antes de invertir o dar su aprobación.
5. Realice periódicamente auditorías de control de calidad y pruebas de usabilidad para documentos y su biblioteca de intranet y sitio web para probar y ver qué necesita actualizar. Utilice personas no técnicas para realizar la auditoría. Obtenga expertos en gestión de contenido para revisar documentos después de la auditoría. NOTA: Esta es la mayor molestia GRACIAS, y le resultará extremadamente difícil lograr que lo hagan.
6. En general, la administración de MBA querrá despedirlo después del proyecto de redacción técnica inicial porque su estilo de administración se enfoca en el arreglo / beneficio a corto plazo, no en el desarrollo de calidad a largo plazo.
7. Una empresa inteligente buscará la cura holística de todo el cuerpo: curación de información “real” (no falsa), diseño de información, facilidad de uso y control de calidad de la información.

Answer 2

No hay dos conceptos básicos de la escritura técnica.

Hay varios. Aquí están:

1. Corrección : Verifique que todo lo que escribe sea correcto. Esta es la consideración más importante, independientemente de lo que alguien más pueda decirte. Decir algo mal es peor que omitir información.

   Tenga en cuenta que su empresa tiene responsabilidad legal por lo que está escribiendo. Incluso un descargo de responsabilidad en la primera página puede no ser suficiente para evitar que su empresa sea demandada si coloca algo incorrecto en el texto que hace que un cliente pierda dinero como consecuencia de seguir sus instrucciones.

2. Claridad : esforzarse por tener un significado claro. Evita la ambigüedad. Dar ejemplos ayuda con explicaciones claras. Puede ser correcto, pero si no está claro, su información es inútil.
3. Concisión : Sea lo más breve posible, sin sacrificar los puntos 1 y 2. Evite las circunlocuciones. Usar voz activa en los procedimientos. Puede ser correcto y claro, pero si continúa demasiado, todos dejarán de leer y sus instrucciones no valen nada.

Los conceptos básicos de escritura 1 – 3 se enumeran en orden de importancia. Si un editor le dice que es mejor ser conciso que correcto, pregúntele acerca de la responsabilidad legal de la empresa y observe cómo su rostro se vuelve pálido. Espere que retroceda rápidamente.

Por el contrario, los siguientes conceptos básicos adicionales se enumeran sin ningún orden en particular:

1. Elija palabras sabiamente : elija palabras que su audiencia probablemente entienda. Evita la puntuación innecesaria.
2. Cubra las excepciones : explique qué hacer cuando las cosas salen mal. Lo más probable es que el lector esté consultando su manual.
3. Integridad : al actualizar un documento técnico o asumir la responsabilidad del material de otro escritor, pregúntese qué necesitaría saber el usuario final y luego verifique que la información se proporciona en el documento. No mire solo lo que ya está en la página, pregúntese qué falta.
4. Verifique su trabajo : corrija todo y pruebe todo. No pierdas el tiempo de tu editor entregando documentación plagada de errores.
5. Consistencia : aprenda el estilo utilizado por su organización. Sea consistente en el uso de los términos. Si dice lo mismo en varios lugares, use la misma redacción.
6. Sensibilidad cultural : personalice su escritura para el país donde se leerá, incluso si allí hablan el mismo idioma. Las diferencias son muchas y sutiles.

Juntos, estos conceptos básicos comprenden las 8 C de la escritura técnica. Los primeros 3 son críticos. Se correcto. Se claro. Entonces sé conciso. Si lo presionan, diría que ser Completo es el siguiente más importante.

Sin embargo, la escritura técnica no se detiene allí. La edición es tan importante como la escritura, ya que la documentación técnica es una colaboración.

Editores, intenten aprender gramática básica. Además, no asuma que tiene razón. Verifique que sus sugerencias y ediciones sean correctas antes de perder el tiempo del escritor. Te sorprendería con qué frecuencia una corrección es realmente una “incorrección”, un cambio espurio que cambia algo correcto en algo incorrecto.

Gracias.

Answer 3

Aquí están los dos 🙂

1. 11 habilidades de un buen escritor técnico
2. Cómo escribir documentación de usuario y manuales de ayuda

Realmente, no puedes caber en dos … Al menos, tres 😉

Answer 4

Descubra quién es su audiencia y escriba para ellos. Use lenguaje e ideas que les resulten fáciles de entender.

No solo documente cómo hacer las cosas correctamente. La gente recurrirá a la documentación cuando algo salga mal: intente evitar los errores que podrían cometer / cometer y explicar cómo resolver esas situaciones.

Answer 5

1. Siempre ponga el punto más importante (conclusión) primero. No esperes hasta el final para decirlo. Los ejecutivos corporativos no quieren esperar hasta el final para escuchar la frase clave.
2. Use viñetas o listas numeradas para hacer subpuntos. No use un párrafo para enumerar puntos.

Answer 6

1. Integridad: la parte que dejas fuera es inevitablemente la pieza crítica que hace que alguien se corte el cabello.
2. Claridad: la ambigüedad es el enemigo.