Escribiré un readme claro y una guía de instalación para tu proyecto web
Auditorías de sitios web con experiencia en web y SEO desde 2020
Acerca de este Servicio
Da a los desarrolladores un punto de partida claro para tu pequeño proyecto web.
Documentaré un proyecto acordado con hasta 5 archivos fuente/configuración relevantes y 500 líneas no vacías en total. Cada paquete usa el mismo alcance de código; los niveles superiores añaden profundidad a la documentación.
Básico: README de hasta 800 palabras, prerrequisitos, instalación, un ejemplo de uso y notas de verificación.
Estándar: hasta 1,400 palabras entre README y notas de resolución de problemas, con hasta 3 ejemplos de uso acordados.
Premium: hasta 2,000 palabras entre README, instalación/resolución de problemas y notas de entrega al desarrollador, con hasta 5 ejemplos acordados.
Verifico las afirmaciones con la versión suministrada y compruebo pasos locales seguros y acordados en un entorno. Los pasos no verificados y los prerrequisitos ausentes quedan claramente marcados. Los entregables son archivos Markdown editables.
La IA ayuda a redactar; yo valido la documentación manualmente. Credenciales, datos personales, código fuente y material confidencial no se envían a herramientas de IA sin consentimiento previo por escrito.
No hay correcciones de código, despliegue, servicios de pago, auditoría de seguridad ni sitio de referencia completo de API. Envíame el alcance del proyecto y la pila antes de hacer el pedido. Inglés o neerlandés; una revisión con alcance.
Tipo de documento:
Documentación
Sector:
Software
Idioma:
Holandés
•
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é tamaño puede tener mi proyecto?
¡Todos los paquetes cubren un proyecto con hasta 5 archivos fuente/configuración relevantes y 500 líneas no vacías en total. Los archivos del proveedor, generados y minificados quedan excluidos de la revisión. Los paquetes superiores aumentan la profundidad de la documentación, no el tamaño del repositorio. Envía la lista de archivos y la pila primero para que pueda confirmar la compatibilidad.
¿Qué incluyen los límites de palabras y ejemplos?
El básico incluye un README de hasta 800 palabras y un ejemplo de uso. El estándar incluye hasta 1,400 palabras en total y 3 ejemplos. El premium incluye hasta 2,000 palabras en total y 5 ejemplos. Estos son topes, no objetivos de relleno; los documentos pueden ser más cortos si así se explica el proyecto de manera clara.
¿Ejecutarás mi proyecto o documentarás algún lenguaje de programación?
Acordamos una pila soportada, versión y un entorno local primero. Verifico pasos seguros dentro del alcance; no habrá código inseguro, secretos o servicios de pago. Las dependencias faltantes y los pasos no verificados quedan registrados claramente. No prometo todas las tecnologías ni sistemas operativos.
¿Harás correcciones de bugs, desplegarás el proyecto o escribirás documentación completa de API?
No. Documentaré la versión acordada y proporcionaré notas de verificación. Las reparaciones de código, características, despliegue, acceso a producción, sitios de referencia completos de API, revisiones de seguridad y entornos adicionales quedan excluidos. Los problemas existentes pueden documentarse sin afirmar que están corregidos.
¿Puedes usar código privado y usas IA?
Comparte solo código autorizado y elimina secretos y datos personales. La IA puede ayudar a redactar; yo valido manualmente la documentación contra el código fuente y pruebas permitidas. El código fuente y material no público no se envían a IA externa sin consentimiento escrito previo. Acordemos cómo manejar material confidencial primero.
¿Qué archivos, lenguajes y revisiones recibiré?
Archivos Markdown editables, un resumen de cambios y notas de verificación, en inglés o neerlandés. Una revisión cubre correcciones o aclaraciones para la versión original, archivos, ejemplos y entorno. Nuevas versiones, características o entornos requieren un acuerdo separado.

