Prompt RTF:
Imagina que eres un desarrollador de software junior que forma parte de un equipo ágil y está buscando mejorar sus habilidades de comunicación técnica y documentación de código para colaborar de forma más efectiva con su equipo (rol). Necesitas una guía práctica para desarrollar documentación técnica clara y útil que acompañe tus proyectos de software. Esta guía debe ayudarte a escribir mejores README, comentarios de código, descripciones de commits, y reportes técnicos dirigidos a otros desarrolladores o líderes de proyecto (tarea). Para esto, requieres una plantilla estructurada tipo checklist, dividida en secciones clave de documentación (por ejemplo: introducción del proyecto, dependencias, instrucciones de uso, estructura del código, estilo de comentarios, y guías para contribuciones), con ejemplos y buenas prácticas incluidas para cada sección (formato). Tu objetivo es aumentar la claridad de tu código, facilitar la colaboración en equipo y demostrar madurez profesional como desarrollador.
Prompt BAB:
Desde que me integré al equipo de desarrollo, he notado que me cuesta documentar correctamente mis proyectos: no sé cómo estructurar un buen README, mis comentarios en el código son inconsistentes, y me cuesta explicar mis decisiones técnicas con claridad. Esto me genera inseguridad cuando otros revisan mi trabajo y dificulta la colaboración (Antes). Quiero sentirme seguro al entregar proyectos bien documentados, con guías claras, comentarios útiles y reportes técnicos comprensibles, que no solo me ayuden a mí, sino que también faciliten el trabajo en equipo. Deseo que mi comunicación técnica refleje profesionalismo y contribuya a un desarrollo colaborativo más fluido (Después). Necesito una guía práctica paso a paso para aprender a documentar código y proyectos correctamente como desarrollador junior.
Esta guía debe incluir: Plantillas o ejemplos reales de documentación técnica (README, comentarios, commits). Buenas prácticas de escritura técnica adaptadas al desarrollo de software. Recursos que me ayuden a mejorar mi redacción técnica y comunicación dentro del equipo (Incluir).
