Depende completamente del tipo de proyecto. Escribir documentación primero puede ser valioso ya que te obliga a pensar en la API desde el punto de vista del usuario. Idealmente, debería poder ejecutar el código README en su proyecto para probarlo y asegurarse de que el código realmente funcione.
Un archivo README bien escrito también sirve para fines de marketing. Escrito de manera efectiva, hace que sea más fácil adoptar su solución. También le servirá en la fase de mantenimiento cuando necesite volver al proyecto más adelante. Te agradecerás por escribir buena documentación entonces.
A veces un README puede ser una ocurrencia tardía. Como mínimo, me gustaría proporcionar una descripción básica, API mínima e información sobre licencias. En proyectos más grandes, envío gran parte de la información a otra parte y utilizo el archivo README para describir el proyecto en un nivel alto, por lo que es fácil comenzar con él.
- Cuando trato de dominar WordPress, ¿domino un tema o todo?
- ¿Python o HTML es más fácil?
- ¿Cuáles son las calificaciones indispensables, además de las habilidades técnicas, que necesito para conseguir un trabajo en los Estados Unidos, como desarrollador frontend?
- Cómo crear maravillas en diseño web y desarrollo de Android, pero no conozco mucha programación
- ¿Qué significa TARGET = '_self' en HTML?
