Leeré tu código primero, luego escribiré la documentación
Desarrollador de Python, aplicaciones de escritorio en Windows, herramientas de IA
Acerca de este Servicio
La mayoría de los README los escribe la persona que ya sabe cómo funciona el proyecto, lo cual es exactamente la persona equivocada para hacerlo.
Yo leo tu código primero, luego escribo la documentación basada en lo que realmente hace, no en lo que recuerdas haberme contado sobre ello.
Lo que obtienes:
- Un README que alguien puede seguir sin preguntarte: qué es, qué necesita, cómo ejecutarlo y qué falla primero.
- Un CHANGELOG que parece una lista de cosas que son diferentes, no una lista de archivos que cambiaron.
- Documentación de configuración o API si tu proyecto la necesita, con los comandos probados en lugar de asumidos.
- Una nota al final diciéndote qué partes de tu código no pude entender, porque esas suelen ser las partes que tus usuarios tampoco entenderán.
Lo que aporto: 23 guías técnicas en mi propio sitio, 46 páginas en inglés y polaco, 53,700 palabras. Nueve artículos en HackerNoon, uno de los cuales alcanzó el número uno en tendencias y fue recogido por el boletín del propio editor.
Inglés o polaco. Envíame un repositorio y dime quién debe leerlo.
Preferencia de estilo de entrega
Informa al freelancer cualquier preferencia o inquietud que tengas con respecto al uso de herramientas de IA en la finalización y/o entrega de tu pedido.
Mi porfolio
FAQ
Traducción automática
¿Tengo que explicarte mi proyecto primero?
No. Envíame el repositorio. Si no puedo entender algo del código, esa es información valiosa y se incluye en el informe.
¿Puedes escribirlo también en polaco?
Sí, ambos, y las dos versiones dirán lo mismo en lugar de ser una traducción que se desvió.
Mi proyecto está sin terminar. ¿Es un problema?
No, pero dilo, y escribiré documentación que sea honesta sobre lo que aún no está construido en lugar de prometerlo.

