La mayoría de los escritos técnicos requieren una combinación de muchas habilidades de MS Office, incluidas Visio, Powerpoint y Excel … Los días de solo texto directo ya pasaron … Además, la escritura técnica para productos de software requiere un conocimiento completo del sistema (o parte del sistema) que se está documentando.
Un escritor técnico debe saber cómo transcribir UML (casos de uso) en gráficos y texto. Además, buen conocimiento de cascada, scrums y metodologías de desarrollo ágil.
Un escritor técnico debe poder diagramar, explicar y comprender JSON y XML, que es básicamente cómo los sitios web transfieren datos de un lado a otro en estos días.
- Soy un estudiante de ingeniería de segundo año. Mi corriente es química. ¿Debo seguir mi clase de entrenamiento GATE desde ahora para descifrarlo?
- Como desarrollador de software, ¿cómo sabe que es lo suficientemente competente para solicitar puestos de trabajo en gigantes tecnológicos como Google, Facebook o Twitter?
- ¿Portugal es una buena opción si opto por una maestría?
- Tengo miedo de conseguir un trabajo, no soy flojo y he llegado a la conclusión de que no estoy seguro de que mi miedo a conseguir un trabajo sea algo más.
- ¿Cuáles son las mejores fuentes de ingresos para alguien que no está dispuesto a hacer el trabajo de 9 a 5 PM?
Los escritores técnicos deben poder revisar todas las opciones de menú en la interfaz de usuario de los productos sobre los que escriben, sin confusión y sin poner a la audiencia de los documentos en una situación “peligrosa”;
Ejemplo; pidiendo a los usuarios que mantengan información confidencial en un búfer de pegado mientras la copian de un sistema a otro; muy peligroso. Lo que lleva a prolly la habilidad más valiosa; Un escritor de tecnología necesita tanto la libertad como la capacidad de poder “retroceder” al equipo de desarrollo para decir que una ruta de desarrollo no es adecuada para los usuarios finales. Esto debería estar bajo el departamento de “QA”, pero muchas veces simplemente no tienen recursos de QA; pero siempre necesitan recursos de redacción técnica, por lo que muchas tareas de control de calidad se transfieren a los redactores tecnológicos.
TLDR: voy a elegir lo que creo que es un buen ejemplo de la mejor herramienta de desarrollo que existe con la peor documentación: Eclipse;
… Que tiene una de las interfaces de navegación de menú más bizantinas que he visto;
…A esto
… Realmente no hay mucha documentación sobre Eclipse porque realmente no hay forma de documentarlo … Cada complemento de eclipse tiene una interfaz de navegación diferente …
El problema con la documentación existente de eclipse es que es básicamente más largo que la biblia;
… Tengo que caminar a través de palabras infinitas cuando todo lo que quiero es crear un nuevo proyecto de Java, poner algunos archivos JAR nuevos en el espacio del proyecto, compilarlo y depurarlo línea por línea … Es bastante fácil una vez que sabes cómo, pero tienes navegar por otros sitios para aprender cómo hacerlo: es prácticamente imposible saber dónde buscar en la documentación del eclipse . Así es como no debería ser la documentación técnica.
Cuál es el punto que estoy tratando de hacer; Los buenos documentos técnicos son muy parecidos a los buenos programas de computadora : tienen capas de abstracción. Los buenos documentos tecnológicos tienen un nivel superior que es para funciones básicas (muy parecido a un ciclo de procesamiento principal en un programa) hasta una inmersión muy profunda. Esto requiere habilidades de escritura muy específicas y conocimiento técnico. Eclipse es un buen ejemplo de lo que sucede cuando el escritor técnico también es el programador; El programador tiene un conocimiento profundo del producto, pero trata de “llegar” al usuario introductorio y (a veces) pierde completamente la marca y simplemente comienza a escribir basura para que parezca que el complemento de eclipse está bien documentado.
Hay una broma muy antigua en TI: la buena escritura tecnológica se parece mucho al sexo. Cuando es bueno, es muy muy bueno. Cuando es malo, es mejor que nada. Pero sí, creo que la escritura tecnológica requiere una buena habilidad técnica, pero generalmente se encuentra buena escritura técnica fuera de los productos que se documentan; stackoverflow, o blogs privados.
Sí, creo que un escritor técnico bueno y completo debe ser capaz de llegar a la audiencia deseada y poder explicar los matices técnicos del producto sobre el que se está escribiendo, todo mientras se mantiene al día con el ciclo de desarrollo de una manera inteligente. No creo que las clases académicas puedan enseñar este proceso, porque cada producto tiene un flujo diferente y un conjunto diferente de capacidades para documentar. La mejor solución es que el escritor técnico tenga la misión de comprender todo lo posible sobre el producto sobre el que se está escribiendo, y mantenerse al día y ser un miembro significativo del equipo de desarrollo.