Escribiré documentación de API, guías de usuario, guías de instalación
Ayudarte a arreglar sitios web y explicar la tecnología claramente
Acerca de este Servicio
¿Te cuesta explicar tu producto, API o software a usuarios y desarrolladores? Transformo información técnica compleja en documentación clara y fácil de escanear que realmente se usa, no que se abandona por leerla superficialmente.
Lo que escribo:
Documentación de API - Documentos de REST API, referencias de endpoints, ejemplos de solicitudes/respuestas, guías de autenticación
Guías de usuario - Guías de incorporación, recorridos por funciones, artículos de cómo hacer, contenido de base de conocimientos
Guías de instalación y configuración - Instrucciones paso a paso, requisitos del sistema
Documentación de resolución de problemas - Preguntas frecuentes, guías de diagnóstico, documentos de resolución de problemas comunes
Archivos README - Archivos README.md en GitHub para proyectos de código abierto o internos, incluyendo instrucciones de configuración, ejemplos de uso y directrices de contribución.
Por qué trabajar conmigo:
- La documentación está escrita para cumplir tareas, no por cantidad de palabras; cada documento responde a "¿qué hago después?"
- Estructurada para facilitar el escaneo: encabezados, pasos numerados, bloques de código y tablas donde ayudan
- Sigo guías de estilo existentes (o ayudo a crear una si no tienes)
Ideal para: startups SaaS, productos con API primero, proyectos de código abierto, herramientas para desarrolladores y cualquier equipo de software que necesite documentación que un usuario pueda seguir sin tener que enviar un email a soporte.
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
P: ¿Necesito proporcionar detalles técnicos o puedes investigar mi producto tú mismo?
R: Puedo trabajar de ambas maneras. Si me proporcionas acceso al producto, documentación existente o una llamada para explicarme, recopilaré los detalles técnicos directamente. Si prefieres darme notas preliminares o una demo funcional, puedo investigar y hacer preguntas aclaratorias según sea necesario.
P: ¿En qué formato se entregará la documentación final?
R: Word/Google Docs, HTML o directamente en tu plataforma (Notion, GitBook, etc.), lo que mejor se adapte a tu flujo de trabajo. Avísame tu preferencia antes de comenzar.
