En el Curso de Arquitectura de la Información con Usaria estudiamos más a fondo todo sobre los flujos y buenas prácticas de navegación en general. 👐
Introducción al Technical Writing
¿Qué es Technical Writing? Lleva tu documentación al siguiente nivel
Habilidades para convertirte en Technical Writer
¿Conoces a tu público? Escribe específicamente para tu audiencia
Cómo entrevistar equipos de programación para recolectar información técnica
Estructura gramatical
Un repaso por la gramática básica
Uso correcto de acrónimos y abreviaturas para explicar términos desconocidos
Voz activa vs. voz pasiva: estándares y estructura de una oración
Técnicas de escritura fundamentales para documentos técnicos
Sigue las reglas de George Orwell para escribir con claridad
Uso correcto de listas y tablas para ordenar información
Tipos de párrafos y paso a paso para estructurarlos
Conceptos básicos de programación e ingeniería de software
¿Qué es programación? Evolución de la documentación y technical writing
Lenguajes de programación, tipos de datos y estructura de documentos HTML
Estándares de documentación de código
Cómo documentar una función de código
Buenas prácticas de legibilidad para código y comentarios
Organización y revisión de tu documentación
Organiza y define el alcance de tus documentos
Utiliza Markdown en documentos técnicos
Guía para revisar documentación en equipo de manera efectiva
Cómo organizar documentos largos
Diseño de documentos
Crea ilustraciones instructivas
Conclusiones
Siguientes pasos para convertirte en Technical Writer profesional
Cómo organizar documentos largos
18/20Lectura
¿Cómo se organiza una gran colección de información en un documento o en un sitio web de manera coherente? ¿Cómo se reorganiza un documento o sitio web desordenado en algo accesible y útil? Son preguntas a las que te enfrentarás una vez que comiences a desarrollar documentos técnicos largos. Pero no todo está perdido, los siguientes procedimientos pueden ayudarte:
...
Regístrate o inicia sesión para leer el resto del contenido.
Aportes 4
Preguntas 1
Ordenar por:
Para la navegación me gusta Notion 🖤 ya que puedo crear una lista de contenidos, así miro los encabezados y al dar click al que me interesa voy directamente. Y todo sin tener que crear los links cada uno a mano.
Yo soy programador y me gusta usar Visual Studio Code para tomar notas ya que puedo ordenar el texto sin necesidad de copiar o pegar. Y al mismo tiempo ver el producto finale que voy escribiendo con la estructura de Markdow.
Es más probable que los lectores sean receptivos a documentos más largos que les revelen paulatinamente nueva información cuando la necesiten.
Mmm, yo personalmente noto que los libros que son éxito de ventas suelen tener capítulos cortos. Esto puede traducirse en que se puede retener mejor al lector si se tienen algunos documentos pequeños para que el lector sienta que está “completando” una lectura mientras más lee, que si tiene uno largo que debe ser leído de punta a punta para que el lector pueda considerar una lectura como “completada”.
¿Quieres ver más aportes, preguntas y respuestas de la comunidad?
o inicia sesión.