El nacimiento de la documentación técnica | ¿Cuál es el proceso completo de redacción técnica?
Si has realizado prácticas o experiencia laboral como Redactor Técnico, ya deberías comprender el proceso de redacción técnica. Por supuesto, en muchas empresas grandes, es posible que usted solo participe en un determinado aspecto de este proceso. Por ejemplo, usted solo es responsable de escribir, o solo revisar, o solo es responsable de la estructura del documento. Por el contrario, en una startup, es posible que esté involucrado en varias etapas.
Si eres un estudiante actual que aún no se ha graduado y no tiene experiencia en prácticas relevantes, o ya estás trabajando pero tiene la intención de cambiar a una carrera como redactor técnico, es posible que aún tengas dudas sobre la redacción técnica. proceso, o puede que sólo tenga una comprensión parcial del mismo.
La división de los procesos de documentación técnica en diferentes empresas puede ser ligeramente diferente, pero en esencia son similares. No importa en qué parte del proceso se encuentre, comprender todo el proceso desde una perspectiva macro lo ayudará a obtener una comprensión más clara y a sentirse cómodo asumiendo otros aspectos del trabajo cuando sea necesario.
Aquí compartiré contigo un proceso completo de redacción de documentos técnicos. Sólo necesitas recordar seis palabras. Como se muestra en la siguiente imagen:
Déjame explicarte nuevamente, el proceso de redacción técnica que ya conoces del trabajo o con el que estás a punto de entrar en contacto no es necesariamente exactamente el mismo que el de la imagen de arriba, sino un El proceso completo generalmente cubrirá estos contenidos, y la diferencia es principalmente Es solo una división subjetiva. No hay necesidad de discutir con el espíritu de "busquemos fallas" ~
El trabajo en la etapa de preparación incluye principalmente. los siguientes puntos:
Antes de redactar el documento, es necesario aclarar los requisitos de documentación. Debe comprender por qué desea escribir este documento y qué propósito desea lograr al escribirlo.
Tenga claro también la audiencia del documento. Es probable que el contenido sea diferente según la audiencia. Por ejemplo, la documentación para desarrolladores y no desarrolladores/usuarios comunes tendrá una organización de contenido diferente.
Defina también el alcance del documento. Piense y determine qué contenido o módulos debe cubrir este documento y qué contenido no cubrirá. De esta manera, tendrás cierta concentración a la hora de recopilar información más adelante y no serás vago al escribir.
Los amigos que tienen experiencia en la redacción de documentos técnicos definitivamente sentirán lo mismo. Si no entiendes algo, escribir documentos para ello es simplemente demasiado doloroso.
Entonces, ¿cómo puedes evitar el dolor cuando te encuentras con un tema desconocido que te deja desorientado? Por supuesto, hago lo mejor que puedo para entenderlo.
Pero ¿cómo hacerlo concretamente? En resumen, significa recopilar información. Entonces, ¿cómo recopilar información? El autor cree que podemos partir de los siguientes puntos:
1) Investigar los documentos relevantes de productos similares más representativos o productos similares para ver cómo se hacen los documentos de otras personas.
Cuando no sabes nada, es una buena opción aprender de las experiencias y prácticas de otras personas. Al comparar la documentación de varios productos, puede establecer un marco aproximado para la documentación que desea escribir.
Cabe señalar que la referencia no es una copia, solo se utiliza para proporcionar ideas; diferentes productos tendrán una planificación estructural diferente del documento.
2) Utiliza los métodos más efectivos para recopilar todo tipo de información relacionada con el documento que estás redactando.
La información recopilada probablemente pasará a formar parte del documento publicado después de haber sido extraída y organizada por Technical Writer.
Existen muchas formas de recopilar información, como búsquedas en Internet, cuestionarios, entrevistas, experimentos, así como discusiones por correo electrónico, informes, artículos técnicos, etc. Qué método utilizar requiere un análisis detallado. Debe elegir un método que pueda recopilar de forma rápida y precisa los datos necesarios en función de factores como los requisitos de documentos, los plazos y la riqueza de los datos existentes.
Hay algunos temas de escritura para los que una búsqueda en Internet puede resultarle de poca ayuda. Incluso para este tipo de contenido, puede obtener información de los desarrolladores. Puede pedirles que le ayuden a proporcionar información según sus necesidades, o puede obtener la información que necesita a través de notas de desarrollo y discusiones en el sistema interno.
Para la documentación de productos de software, incluso si hay alguna información técnica, el redactor técnico a menudo necesita usarla él mismo, para tener una comprensión intuitiva de los pasos de operación y obtener información de primera mano sobre la redacción de documentos. .
Cuando la información esté casi recopilada, puedes organizar la estructura específica de este documento. Investigaciones previas sobre productos similares pueden ayudarte en este momento.
Para las guías de uso de productos comunes, generalmente están organizadas en el orden de instalación o uso; para otros documentos que no son guías, también deben seguir un cierto orden o lógica.
Además, también hay que considerar si el documento debe ir acompañado de imágenes y si es necesario utilizar tablas. Si necesita agregar imágenes, deje en claro si necesita ayuda de otras personas o si debe completarlas usted mismo. Dibujar una imagen más compleja también es una tarea que requiere mucho tiempo y también se debe tener en cuenta el tiempo invertido.
Una vez que tengas una estructura detallada del documento, puedes pasar al siguiente paso de redacción.
Si ha realizado bien los primeros pasos, escribir será muy sencillo. Sólo necesitará completar con precisión el contenido correspondiente en la estructura del documento. En este proceso, es necesario escribir párrafos o pasos específicos. Este es un momento para reflexionar sobre sus habilidades lingüísticas y de escritura.
Algunos libros de redacción técnica dicen que no es necesario preocuparse por la gramática, la redacción y la puntuación al escribir documentos, y creen que estos detalles deben mejorarse en la etapa de Revisión.
Tengo una opinión diferente sobre esto. Un redactor técnico calificado debe tener buenas habilidades lingüísticas. Los detalles más básicos, como la gramática, la redacción y la puntuación, no deben convertirse en un problema que deba resolverse solo. La gramática estándar, la redacción decente y la puntuación correcta deberían haberse convertido en un hábito de escritura que no requiere esfuerzo adicional y casi no requiere tiempo adicional.
Si el primer borrador es aproximado y contiene muchos pequeños detalles que deben modificarse, esto definitivamente aumentará la carga de trabajo y el costo de tiempo durante la revisión, retrasando así el proceso del documento.
Quizás, este método pueda adoptarse para grandes empresas que tienen una fina división del trabajo y cada persona sólo es responsable de un pequeño eslabón. Sin embargo, esto no se aplica a las startups que se están desarrollando rápidamente y requieren un desarrollo ágil de la documentación.
Después de escribir el primer borrador de un documento, normalmente necesita más revisiones y mejoras. Revisión aquí se refiere a la modificación después de la revisión, por lo que este paso también se puede llamar: Revisión y Revisión.
Entonces, ¿quién necesita revisarlo? Los documentos técnicos generalmente requieren que otros revisores realicen dos tipos de revisiones, a saber:
Después de recibir comentarios del revisor, el redactor técnico debe emitir juicios y modificaciones oportunas. Cualquier área poco clara debe discutirse y determinarse. el revisor. Después de realizar los cambios, pídale al revisor que le eche un vistazo. Si se descubren nuevos problemas, es necesario modificarlos nuevamente. Este proceso de revisión-revisión puede repetirse varias veces, lo cual es normal.
Por supuesto, antes de pedir a otros que lo revisen, Technical Writer también puede revisarlo él mismo para intentar evitar errores de bajo nivel y no hacer perder el tiempo a otras personas.
Jaja, aquí viene el problema nuevamente ~ Por lo general, las personas que acaban de terminar de escribir un artículo son muy reacias a leer lo que han escrito. En este momento, puede utilizar algunas herramientas de revisión gramatical y ortográfica. tú.
En un artículo anterior, recomendé dispositivos útiles para el escritor técnico en el trabajo diario. Los amigos que los necesiten pueden hacer clic en el enlace para echar un vistazo ~
Si crees que eres lo suficientemente cuidadoso. que no necesitas dispositivos que te ayuden. Admiro tu habilidad, pero aún así recomiendo usar dispositivos. Porque puede haber momentos en los que estés en mal estado, momentos en los que estés cansado y dormido, momentos en los que no sepas qué diablos has escrito... No seas duro contigo mismo y con tus gadgets.
Una vez finalizado el documento, se puede publicar en la plataforma, que generalmente es fácil de operar.
Diferentes empresas tienen diferentes plataformas de publicación de documentos y las herramientas de escritura utilizadas por los redactores técnicos también son diferentes.
La publicación del documento no significa el final. Según mi experiencia laboral, incluso los documentos publicados pueden tener problemas, ya sean documentos de empresas grandes o pequeñas. Por ejemplo: errores de texto no descubiertos, enlaces rotos, descripciones y pasos que ya no coinciden con los últimos productos, etc. El redactor técnico debe mantenerse al día con los desarrollos de productos para poder actualizar los documentos de manera oportuna.
Escribir documentos técnicos no es algo que se haga una sola vez. Mientras el producto esté actualizado, Technical Writer debe continuar manteniéndolo.
Lo que se comparte arriba es un proceso completo de documentación técnica desde cero. En el trabajo diario, a veces no es necesario empezar desde cero, solo agregar, eliminar y modificar los documentos originales, lo que puede guardar algunos enlaces correspondientes.
Si también es redactor técnico y espera escuchar sus opiniones sobre el proceso de redacción técnica, deje un mensaje para intercambiar ~
Referencia:
Quizás quieras leer:
Gadgets útiles del redactor técnico en el trabajo diario
La traducción técnica requiere el sentido del redactor técnico
Un análisis en profundidad de seis cosas sobre traducción técnica Malentendidos cognitivos
¿Cómo hacer que su contenido sea más profesional y diseñado?
Lista de libros | ¿Cuáles son los libros de lectura obligada para los profesionales de la comunicación técnica?
¿Cuáles son algunos blogs de alta calidad adecuados para los profesionales de la comunicación técnica? (1)
¿Cuáles son algunos blogs de alta calidad adecuados para los profesionales de la comunicación técnica? (2)
Intercambio de experiencias | Consejos sobre desarrollo profesional de 11 redactores técnicos sénior (Parte 1)
Intercambio de experiencias | Consejos sobre desarrollo profesional de 11 redactores técnicos sénior (Parte 2) )
¿El título de un documento técnico en inglés debe estar en mayúsculas o minúsculas?
¿Cómo agregar y eliminar caracteres por lotes usando expresiones regulares?
Markdown: un lenguaje de marcado liviano que es útil para escribir documentos técnicos, blogs personales y leer notas
¿Cómo generar automáticamente una tabla de contenido para archivos Markdown?
Análisis de ejemplos de escritura técnica | La simplicidad es hermosa
Dos minutos de interesante interpretación de Technical Writer
Si está divorciado de la comprensión, ¿de qué sirve? traducción literal correcta?
Una traducción de calidad no sólo debe ser correcta, sino también bien organizada.
Escrita un mes después de incorporarse a la startup tecnológica PingCAP.
Revelando el trabajo de un entorno de redacción técnica | Cinco meses de experiencia como empleado después de unirse a PingCAP
-END-