¿Es exagerado seguir las guías de estilo para la escritura técnica?

No, no es exagerado seguir un libro de estilo. Como han dicho otros, lo consulta a medida que surgen preguntas y aprende sobre la marcha; normalmente no lo lees de cabo a rabo. Todos ponemos notas adhesivas en las secciones consultadas con frecuencia. Dado que se tomó la molestia de hacer su pregunta, obviamente le molesta la falta de consistencia dentro de su empresa.

Además, dado que escribe mucho para su trabajo, es probable que ya ESTÉ siguiendo un estilo. Le sugiero que comience a compilar un documento que incluya todas las cosas que busca constantemente y cree su propia guía de estilo. Quién sabe, ¡tal vez su empresa algún día adopte su guía! (Una sugerencia: a medida que compila su propia guía, tome nota de la fuente autorizada en la que basa cada "regla" para que pueda consultarla si es necesario).

Mi empresa sigue The Associated Press Stylebook , excepto cuando no lo hace. Tenemos un documento de Word con las excepciones, que se actualiza a medida que se toman las decisiones. (Siempre se anota en el archivo la fecha en que se cambia una regla). Además, AP cambia su estilo en ocasiones, y mi empresa tiene que decidir si están de acuerdo. Como ejemplo, el año pasado AP cambió el correo electrónico por correo electrónico. Mi empresa no lo hizo.

Para la documentación que se publicará fuera de su organización, por lo general es importante seguir una guía de estilo (prácticamente cualquiera) para que toda la documentación se lea con una "voz", aunque haya sido escrita por un grupo de personas diferentes. Como señaló Lauren Ipsum, no lee la guía de estilo de cabo a rabo, sino que la consulta en puntos individuales. (Sin embargo, deberá familiarizarse con los puntos que cubre).

Dije que es "usualmente" importante; debe hacer la pregunta primero antes de proceder a adoptar una guía. Existe una práctica existente de "sálvese quien pueda"; ¿Son las cosas así porque realmente no les importa a las personas a cargo, o solo porque la pregunta nunca ha surgido? Si no es importante para ellos, entonces deberá argumentar que es importante en proporción al costo de adoptar una nueva práctica. El precio de compra del libro es ruido; el costo estará en cambiar los hábitos de trabajo de todos. Si los clientes (u otras personas importantes) ven esta documentación, entonces puede ser un lanzamiento fácil; si solo lo usan los miembros de su equipo, puede que no importe (por mucho que me duela, como escritor, decir eso).

Creo que estás confundiendo una guía de estilo con un manual de estilo. El Manual de Estilo de Chicago ayudará, pero es más un libro de referencia de las mejores prácticas, en lugar de un conjunto de políticas y procedimientos para guiar los procesos de desarrollo de documentos para su uso comercial particular.

Parece que una guía de estilo es lo que espera crear e implementar en toda la empresa, algo que estandarice cosas como secciones en un informe o guía de usuario, tipos de letra utilizados, uso de logotipos y marcas registradas, software que se utilizará para crear documentación y diseño de plantillas. estándares Realice una búsqueda en la web de "guía técnica de estilo" y encontrará ejemplos.

Sin embargo, crear la guía de estilo no será su mayor tarea. Lograr que la gerencia lo implemente como un requisito será el mayor desafío, y si no lo tiene, desperdiciará su trabajo y se molestará a usted y a sus compañeros de trabajo. La clave para obtener la aceptación de la gerencia es hacerles entender que la documentación consistente es parte de la marca y los mensajes consistentes: su documentación es parte del esfuerzo de marketing.

Una vez que tenga la gestión detrás de su esfuerzo, involucre a sus colegas y trabaje en equipo para crear una guía de estilo adaptada a la cultura y los flujos de trabajo de su empresa. Incluya miembros clave de los equipos de ingeniería, servicio al cliente y marketing en este esfuerzo también, para que la ingeniería esté en sintonía con la programación de los plazos de entrega de la documentación, aprenda qué en la documentación es confuso o frustrante para los clientes de las personas que tienen que tratar con ellos con regularidad y asegurarse de que los términos que está utilizando en la documentación son los mismos que utiliza el departamento de marketing, también que se dirige a la audiencia correcta al comprender la base real de clientes y su uso real de los productos.

Algunas guías de estilo también cubren los procesos de distribución de documentos y las políticas de retención. Estos también se pueden tratar en procedimientos separados, como mejor se adapte a su uso comercial.

No exagerar en absoluto. Sin embargo, el Manual de estilo de Chicago no es realmente ideal para la escritura técnica (y está pensado como una referencia de búsqueda, no como una lectura de principio a fin). Es una buena guía de escritura general y formal para los estadounidenses. Para una audiencia más internacional, el equivalente es The Oxford Guide to Style (también conocido como New Hart's Rules , también publicado como la mitad del Oxford Style Manual ).

El problema principal con Chicago es que sus editores se oponen firmemente al uso de citas lógicas (es decir, incluir entre comillas nada que no esté presente en la cita original) excepto "crítica textual" y "códigos y comandos de computadora". Por lo demás, no recomiendan nada más que el periodismo estadounidense y la puntuación de las citas al estilo de la ficción, en las que los puntos (puntos, puntos) y las comas siempre se colocan dentro de las comillas, incluso si no pertenecen lógicamente allí. Esta es una idea terrible en cualquier forma de escritura técnica u otra precisa, aunque sigue siendo favorecida por el AP Stylebook y otros manuales de estilo periodístico estadounidenses.

Si la redacción técnica es su trabajo, le aconsejo tener los manuales de Chicago , Oxford y AP (así como cualquier otra guía de estilo que pueda necesitar, por ejemplo, el Bluebook y Redbook legales , y el equivalente de Oxford, OSCOLA , que es un PDF gratuito y/o las guías de estilo científicas/médicas CSE , AMA y APA ). Adapta tu estilo según sea necesario. Para comunicaciones comerciales con estadounidenses, utilice Chicago ; para materiales de relaciones públicas destinados a estadounidenses, utilice AP ; para una audiencia internacional, confíe en Oxford(también al citar con alta precisión, por ejemplo, comandos escritos o las etiquetas en los controles del dispositivo). Recurra a CSE , etc., según sea necesario para la redacción científica. También es posible que en ocasiones se le solicite que cumpla con el Manual de estilo de MLA para algunos fines. Todos estos libros son una buena inversión para cualquier escritor profesional de no ficción. También lo es actualizarlos a nuevas ediciones a medida que se publican; a veces los cambios son significativos (aunque tardan algunos años en propagarse). El uso efectivo del lenguaje es un blanco móvil.

¿Cómpralo? Sí. No creo que necesites leerlo de cabo a rabo a menos que seas un experto en idiomas que lee diccionarios por diversión. ::tos tos::

(Sacando mi 14ª edición como referencia...)

Trataría de leer tanto de "Las partes de un libro" y "Preparación del manuscrito" como pueda antes de que sus ojos se nublen. A menos que estés leyendo el trabajo de otra persona, puedes hojear la sección de revisión. También sería bueno leer "Diseño y tipografía".

Todo lo demás que puede buscar a medida que lo encuentre: ¿Uso la coma serial? ¿Esta oración toma "cuál" o "eso"? ¿Cómo cito un sitio web en una bibliografía?

No creo que seguir una guía de estilo sea excesivo. Es realmente útil tener una respuesta autorizada a cosas como si usar el correo electrónico o el correo electrónico y no tener que buscarlas una docena de veces o discutir sobre ellas con otras personas. Sin embargo, CMOS probablemente sea demasiado detallado para sus necesidades, y ciertamente no lo leería de cabo a rabo. Incluso siendo alguien cuyo único trabajo es escribir, no me sentaría a leer una guía de estilo de principio a fin. Para un ingeniero eléctrico, no creo que sea un buen uso de su tiempo.

Actualmente en mi estantería, tengo The AP Stylebook y The Microsoft Manual of Style. Me gustan ambos, aunque AP no usa comas en serie y personalmente me gustan las comas en serie. Microsoft es realmente útil para las instrucciones de software porque define cómo dar formato a los nombres de botones, ventanas, pantallas y menús.

En realidad, podría ser más útil redactar su propia guía de estilo y crear una plantilla para los documentos que escribe con más frecuencia. La guía de estilo puede ser una simple lista de decisiones de estilo; no necesita incluir todo bajo el sol. Cuando escribo manuales de usuario, enumero todas las partes de la interfaz y cómo diseñar esos términos. (Por ejemplo, si la aplicación tiene un pequeño mapa 3D para la navegación, anoto si se llama Minimapa, Minimapa, Mapa 3D, Mapa de navegación o lo que sea). También incluyo cualquier término que surja que tener más de una ortografía estándar o separación silábica. Cada vez que tengo una pregunta sobre un término cuando estoy escribiendo o editando, una vez que lo resuelvo, lo agrego a la lista.

Puede usar esa guía de estilo solo para usted o, dependiendo de cuánto empuje tenga y cuánto le importe a su organización la consistencia de la escritura, compártala con el resto de su equipo.

Los estándares IEEE son un buen recurso para desarrollar plantillas, porque su estándar para un documento determinado generalmente incluye un esquema de muestra y una descripción del contenido de cada sección. Por lo general, no es demasiado difícil configurar un documento de Word con el formato específico que desea, todas las secciones dispuestas y comentarios que indican lo que realmente debe ir en esas secciones.

Si la documentación solo va a ser escrita por una persona y leída por el mismo grupo de personas, esa documentación no requiere un estilo (suponiendo que sea documentación interna, no dirigida a los clientes). Siempre y cuando ambos lados lo entiendan, puede funcionar, aunque los principiantes en la lectura pueden tardar un poco en entenderlo. Si escribirlo en griego bíblico funciona para esta situación, no hay problema en hacerlo.

Sin embargo, casi toda la documentación, incluso interna, será escrita por más de una persona y leída por diferentes personas a lo largo del tiempo. Pueden ser instrucciones para las pruebas, pero es posible que los auditores de control de calidad también necesiten verlo. Los documentos de instrucciones pueden estar destinados inicialmente a un conjunto de grupos, pero luego pueden almacenarse para nuevas personas. Por lo tanto, algún tipo de estándares es una buena idea, aunque es posible que no necesiten ser tan rigurosos como para los usuarios externos.

El propósito no es garantizar que todo sea siempre consistente y profesional, es garantizar que las personas nuevas puedan comprender e interpretar la documentación de la manera correcta. Por lo tanto, los errores tipográficos menores no son tan importantes, pero la claridad y la consistencia sí lo son.

El AP es muy similar al Manual de estilo de Chicago , pero mucho más fácil de usar. ¿Por qué ir contra la corriente? Vas a llegar a la audiencia más amplia posible con AP, que creo que debería ser el objetivo final aquí.

CMOS no tiene ningún valor real para usted. Y soy miembro vitalicio de IEEE, pero hacen muchas cosas que son burocráticas y despiertas, pero que no tienen ningún valor real para los miembros.

Su empresa debe proporcionar una guía de estilo que sea mucho más pequeña pero que haga el trabajo que necesitan.

Formatear documentos no es exactamente estilo como uso las palabras. Y sería una de las funciones de edición más abajo en la lista y mucho más allá del esfuerzo de escritura real.

Si el formato es el problema real, entonces deben proporcionar una plantilla para guiar la estructuración de los resultados que escribe.

El problema real suena más como niveles de edición. Y qué hacen los editores en esos niveles (o usted).

Si el problema es la estructura, entonces una plantilla podría eliminar la necesidad de un editor de desarrollo para estructurar el informe a un alto nivel antes de comenzar. ¡Nunca intentes hacer eso después de haber escrito!

Si el estilo es realmente el problema, entonces deberían tener un departamento de edición que convierta los informes de ingeniería en algún "estándar".

La edición de líneas, la edición de copias, las comprobaciones de SPAG y las cosas de bajo nivel tampoco son estilo, pero también son importantes.

Tratar de imponer algún CMOS como guía a los ingenieros sería disruptivo y contraproducente.

Busque algunas plantillas de informe de prueba de modelo y elija una que le guste y luego sugiera que la gerencia considere que todos los informes sigan ese modelo.

Si su inquietud es otra cosa, haga otra pregunta más directa al problema y díganos exactamente cuál es el problema que tiene con los informes.