Uso correcto de acrónimos y abreviaturas para explicar términos desconocidos

Creo que el mejor ejemplo de esto es Wikipedia, dado que define al inicio los acrónimos o abreviaturas, y a cada termino desconocido lo enlaza con su definición (Así si no conoce el termino pues puede consultarlo). Y al final deja una sección llamada: “Notas y referencias” y “Enlaces externos” para complementar la lectura.

Me hubiera gustado que también pusieran reto en esta sección, ya que me ayudan a reforzar lo aprendido.

• Explicación de términos nuevos o que la mayoría desconoce, y ponerlos en un glosario
• Usar términos coherentes y ocupar los mismos en la documentación
• Si usas abreviaturas primero escribir el nombre completo y después su abreviación para que el lector entienda que de ahora en adelante aparecerá abreviado
• Similar a los acrónimos, primero escribir el nombre completo seguido de el acrónimo en paréntesis, para poder ocupar el acrónimo mas adelante.

En un curso que tome de Oratoria nos mencionaban que es mejor hablar y escribir en positivo así generamos armonía y tranquilidad al leer. Ejemplo:

Negativo: A continuación veremos los problemas mas comunes dentro del proyecto. -> Solo resaltas que hay problemas.
Positivo: A continuación veremos los puntos de mejora mas comunes dentro del proyecto. -> Invitas a dar una solución.

📌 Los tres párrafos que más me llamaron la atención:
.
▶ Supongamos que escribiste algunas líneas de código y a una variable llamada nombre le cambias el nombre por name a la mitad de la ejecución de un método. Es evidente que tu código no compilará. Eso mismo pasa cuando escribes un documento y usas un término de manera frecuente, si a mitad del documento lo cambias, el hilo de tu texto se perderá y las ideas en las cabezas de tus lectores no “compilarán”.
.
▶ El acrónimo tiene cierta similitud con las siglas, la única diferencia es que un acrónimo puede formarse tomando tanto la inicial como la primera parte de las palabras que forman el nombre completo, en cambio, la sigla siempre se forma con la letra inicial.
.
▶ Wireless Fidelity (WiFi): este término fue creado por una empresa de branding y solo se hizo popular en su forma abreviada.

Yo solía hacer las cosas al revés de como lo explica esta lectura. Colocaba el acrónimo al inicio y entre paréntesis colocaba su definición larga.

HTTPS (Hypertext Transfer Protocol Secure)…

Es muy útil haber encontrado esta lectura para saber que lo que estaba haciendo estaba mal, ya sé que debo arreglarlo para el futuro.

Me llamo la atención lo del WIFI y las ondas de radio lo busque(wikipedia) y los tres primeros textos los hice medio. 🐰😎
https://bit.ly/3hFY3ED
Pueden ser creadas de manera natural por fenómenos naturales tales como relámpagos, o por objetos astronómicos. También pueden ser generadas de manera artificial como en radares ó redes telemáticas. Sí las ondas de radio que son un tipo de radiación electromagnética. Como todas las ondas electromagnéticas si viajan por el vacio las ondas de radio viaja a la velocidad de la luz y su propagación se mide en frecuencias de 10THz hasta 10kHz.

Acrónimo

• OPEP: Organización, petróleo, país exportador
• RRHH: Recursos Humanos
• DND: No molestar
• ASAP: Tan pronto como sea posible
• DIY: hágalo usted mismo
• PIN: Número de identificación personal
• FBI: Oficina Federal de Investigaciones
• NASA: Administración Nacional de Aeronáutica y del Espacio
• SIDA: síndrome de inmunodeficiencia adquirida.
• FYI: para su información
• ATM: cajero automático
• OVNI: Objeto volador no identificado
• VIH: virus de la inmunodeficiencia humana
• IQ: Cociente de inteligencia
• SOS: Salva nuestras almas

Abreviatura

• Km: Kilómetro
• Dpto: Departamento
• Eng: Inglaterra, inglés
• Col: Coronel
• Geog: Geografía
• Lit: Literario, Literatura
• Ref: Referencia
• Rept: Informe
• Viz: Videlicet
• Año: año
• St: Santo
• Asunto : Asunto
• Univ: Universidad
• Vocabulario: vocabulario.

Fuente

Esta acción de definir se puede ver en todas las documentaciones oficiales de reconocidos softwares. Creo que también agregaría el hecho de que se agregue un índice y una sección donde se hablen exclusivamente de los tecnicismos que pueden resultar mas complicados de comprender.

Que bueno seria que para estas clases de lectura se pueda mover el panel de comentarios o hacer la vista más grande

Excelente el contenido del curso