Escribiré un readme claro, una guía de configuración o documentación de API para tu proyecto
Acerca de este Servicio
Código bien escrito con documentación deficiente cuesta tiempo. Los desarrolladores y usuarios nuevos no pueden empezar, y tú respondes las mismas preguntas una y otra vez. Escribo documentación que la gente puede seguir.
Tengo alrededor de 10 años de experiencia en desarrollo pagado, con proyectos de Flutter, web, backend y nube. Leo tu código y escribo la documentación que necesita.
Qué escribo:
- Archivos README: qué hace el proyecto, cómo instalarlo, cómo ejecutarlo
- Guías de configuración para desarrollo local
- Guías de uso para los usuarios
- Documentación de API: endpoints, parámetros, ejemplos y códigos de error
Qué obtendrás:
- Archivos Markdown listos para añadir a tu repositorio
- Oraciones claras y cortas con ejemplos funcionando
- Una estructura de documentación única para todos tus archivos
Cómo funciona:
- Comparte tu repositorio y dime quién leerá la documentación.
- Confirmo el alcance antes de empezar.
- Recibes los archivos como pull request o como un zip.
No incluido: trabajo que requiera llamadas en vivo y redacción académica.
Idioma:
Inglés
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.
FAQ
Traducción automática
¿Qué formato entregas?
Markdown por defecto. Pregúntame por otros formatos antes de hacer tu pedido.
¿Necesitas acceso a mi código?
Sí. La documentación debe coincidir con el código real.
¿Podemos hablar en una llamada?
No. Trabajo a partir de briefs escritos claros. Respondo a mensajes dentro de 24 horas en días hábiles.
¿Puedes documentar una API con un archivo OpenAPI?
Sí. Si tienes un archivo OpenAPI o Swagger, envíalo. Así se acelera el trabajo.
