Si está documentando software, entonces saber cómo escribir código puede ser muy útil. Por ejemplo:
- Es genial cuando un programador dice, por ejemplo, “Eso no se puede hacer”. y puedes decir “Sí, puede. Así es como”. porque asegura que esa persona te tomará en serio. Esto es como el oro para un escritor de tecnología.
- Al aprender sobre el software, a menudo encontrará problemas con él. Saber cómo codificar le informará si se trata de un error de código, un problema de diseño, un problema con el entorno de ejecución o tal vez algo más. Ese conocimiento es necesario para saber cómo documentar una ‘característica’ o informar un error. Un escritor técnico que puede codificar puede ser un excelente probador ‘alfa’. Lo sé porque lo he hecho, y es divertido.
- A veces puede aprovechar su habilidad de codificación para extraer información del código para mejorar su documentación. Por ejemplo, es posible que desee una lista completa de todos los métodos en una clase, o una lista de todas las URL en algún contexto. Si puede obtener esto usted mismo en lugar de rogarle a un desarrollador que lo proporcione, mucho mejor. (Por supuesto, pasas tiempo escribiendo un guión o aprendiendo una herramienta).
Por otro lado, si puede leer el código del software, está tentado a hacerlo para no perder el tiempo pasando por el desarrollador. Pero, por lo general, es una mala idea, ya que puedes quedarte atado fácilmente a una maraña de detalles que no necesitas.