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
Lectura
En esta clase aprenderemos a documentar código de muestra de una manera legible. El objetivo es proporcionar calidad y coherencia en toda tu documentación, no funcionalidad. El código de muestra sirve como un mini-portal al contenido de una documentación completa.
...
Regístrate o inicia sesión para leer el resto del contenido.
Aportes 7
Preguntas 1
Este es un ejemplo de cómo yo documento código de muestra:
Colores
Principalmente para unir conceptos y así encontrar el código con la definición o explicación
Comentarios y bloques de código
Cosas como if no es necesario explicarlo, pero qué hace cada función y la explicación de líneas más complejas si llevan su comentario
Tengo una super duda, yo acostumbro a poner cabecera en todas mis clases indicando lo siguiente:
¿Qué opinan sobre esta practica?
<!--
@description : url_de_documentacion_en_git
@author : programador_que_creo
@group : equipo_responsable_de_proyecto
@last modified on : 21-01-2021
@last modified by : programador_que_modifico
-->
uso Visual Studio Code y encontré una extensión que ingresa y actualiza la cabecera por mi, se las dejo a quien sea de su interés. Salesforce Documenter
Solo hay un punto, no se en que aspecto o contexto lo tratan de expresar, feminismo?? , no se, pero referirse de repente en femenino y en la mayor parte en masculino, creo que no debe ser así, considero que es sin genero, y se entiende, pero creo que hacer ese énfasis descontextualiza la lectura, se que es un punto de debate, y mi intención no es tal, si no concluir que para mi es universal y así evitamos precisamente eso, dar genero a las palabras , saludos 😃
Yo no sé ustedes, pero el código que se supone es incorrecto… es correcto, y el código que se supone que es correcto… es incorrecto, es decir, si es JavaScript, no puedes poner “;” dentro de los objetos JSON 🤔
📌 Muchos equipos reciclan sus pruebas unitarias y los toman como código de muestra, eso es una mala idea. El objetivo principal de una prueba unitaria es probar; el único objetivo de un código de muestra es educar al usuario.
Ejemplo intermedio: Saludo con función
Lenguaje: JavaScript
<function greet(name) {
console.log("Hello, " + name + "!");
}
greet("John");>
¿Quieres ver más aportes, preguntas y respuestas de la comunidad?