Es una metodología para escribir textos académicos. Su propósito es facilitar el entendimiento al enfocarse en los ejemplos del tema en cuestión.
En Example Driven Writing primero debes definir los ejemplos que vas a utilizar para explicar el tema y después escribir los textos basándose en los ejemplos.
Esto no significa que siempre mostrarás al lector primero el ejemplo y después la descripción. Los componentes pueden estar ordenados de la manera que mejor se adapte a la explicación. La idea es que los ejemplos sean el eje central del documento.
El método es especialmente útil al exponer conceptos desde un enfoque práctico o releer textos recordando el tema desde el ejemplo propuesto.
Python es un lenguaje de programación interpretado cuya filosofía se enfoca en la legibilidad del código. Por esta razón, algunos símbolos comunes utilizados en programación han sido reemplazados por palabras en inglés.
var = object()
if var is not None: # equivalente a: var != None
print('var is not None')En la metodología Example Driven Writing, el índice debe ser escrito basándose en ejemplos o conjuntos de ejemplos que ilustren conceptos.
Por ejemplo, el índice para un documento acerca del uso del lenguaje de programación Python podría ser el siguiente:
- Introducción: Ejemplos de aplicaciones usando Python
- Instalación: Guía de instalación de Python
- Variables: Ejemplos de variables
- Funciones: Ejemplos de funciones
- Clases: Ejemplos de clases
- ...
El punto ciego del experto es un fenómeno que ocurre cuando a una persona con conocimiento avanzado se le dificulta explicar conceptos básicos de ese tema.
Al escribir un texto, debes tener en cuenta que el lector no tiene tu mismo conocimiento. Por lo tanto, el texto debe ser claro y no tener ambigüedades.
Escrito por Alejandro Carrasco Rodríguez © 2022