Ingeniería de software
Cree un recorrido del código para un nuevo ingeniero
Un recorrido para principiantes que comienza con una ruta ejecutable, explica los límites y la propiedad del repositorio y programa ejercicios progresivos de lectura de código.
El proceso
Hazlo en este orden.
- Identifica el rol del nuevo ingeniero, el primer resultado útil, el límite de tiempo, la revisión del repositorio, los requisitos previos locales y las preguntas que debe responder el recorrido.
- Traza un camino feliz seguro desde un punto de entrada hasta una prueba o artefacto, registrando comandos, salida esperada y el cambio útil más pequeño.
- Mapea los directorios principales, los límites de compilación y despliegue, los sistemas de datos y externos, los responsables, la documentación y las decisiones clave.
- Crea paradas graduales con una pregunta de lectura, un pequeño ejercicio, una señal de verificación y una parada clara antes de producción o de un acceso con consecuencias.
- Añade un glosario, enlaces al código y a las decisiones autorizados, trampas comunes, contactos de escalado y orientación para evidencia privada o no pública.
- Valida el recorrido con un compañero o una autocomprobación desde un entorno limpio, corrige los pasos poco claros y registra lo que no se pudo probar.
- Publica el recorrido con versión, responsable de actualización, evidencia de cada ruta, limitaciones conocidas y riesgos no resueltos para futuros mantenedores.
Trae esto
Datos que el gato va a pedir.
- rol del nuevo ingeniero y primer resultado
- repositorio e instrucciones de configuración local
- límite de tiempo y restricciones de aprendizaje
- responsables y contactos de escalado
Router + un playbook
Enruta primero. Elige uno.
Cat Paw carga un playbook por tarea, no mezcla varios. Empieza por este router; el resto son candidatos específicos del workflow.
- Router:
codebase-knowledge-pack skills/codebase-knowledge-pack/codebase-onboarding-tour/SKILL.md
Límites
Los límites viajan con el prompt.
- Verifica las herramientas, cuentas, permisos y el espacio de trabajo reales antes de empezar; nunca afirmes que exista una herramienta, cuenta, fuente o capacidad no disponible.
- Usa Latch/target-workspace para código privado, artefactos, sondeos en vivo o datos no públicos; si ese acceso no está disponible, detente en el límite e informa del bloqueo en lugar de sustituirlo por una suposición.
- Pausa para obtener aprobación explícita antes de acciones externas con consecuencias; devuelve evidencias, riesgos no resueltos, supuestos y cualquier acción que aún esté esperando aprobación.
Listo significa
Un cierre que se puede comprobar.
Un recorrido de incorporación versionado lleva a un nuevo ingeniero desde una ruta ejecutable verificada hacia un conocimiento más profundo del repositorio, con propiedad, ejercicios, evidencia y riesgos no resueltos registrados.
Fuentes
De dónde sale este proceso.
- github.com/Egonex-AI/Understand-Anything/tree/6df3065f1d8ddc2ce3615314d1d493f36d6b1c80/
- c4model.com/
- docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners
Las fuentes fijan el patrón del workflow. Los posts de Reddit y de la comunidad, cuando aparecen, se tratan como anécdotas de quien lo practica, no como hechos universales.