Broklam/readme-constructor

Constructor de README

Construye un README que se ajuste al proyecto y a sus lectores. Trata al usuario como diseñador. Los ajustes predefinidos son propuestas, y la estructura, el contenido y los elementos visuales son decisiones independientes. Utiliza evidencia del proyecto y las decisiones previas del usuario. Nunca inventes funciones, comandos, resultados, imágenes ni afirmaciones.

Descubrir y proponer

Inspecciona el repositorio relevante, la documentación existente, la fuente de la documentación generada y los recursos antes de proponer un esquema. Identifica el propósito del README, la audiencia prevista, el título, el tono y el objetivo de representación cuando estos afecten el diseño. Respeta la ruta de salida solicitada o el borrador solo en el chat. Edita la fuente de documentación cuando se genere la salida. Conserva hechos útiles y recursos existentes, especialmente para un README existente.

Utiliza los menús siguientes de forma selectiva. Sus patrones ofrecen opciones para que el usuario las adapte. Sus ejemplos enlazados son un subconjunto representativo seleccionado del índice Awesome README, resumidos en breves notas originales. No se requiere acceso a la red para usar la habilidad.

• Usa el menú de estructura para proponer un punto de partida ordenado y opciones de secciones.
• Usa el menú de contenido de secciones para elegir el formato, la profundidad y la evidencia para cada sección seleccionada.
• Usa el menú de elementos visuales para elegir elementos visuales individuales, su ubicación y los recursos disponibles o propuestos.

Para un README nuevo o un rediseño importante, presenta un esquema único, personalizado y editable que muestre el orden de encabezados propuesto, una elección de contenido para cada sección y cualquier elemento visual colocado individualmente. Incluye opciones de contexto breves solo donde sigan siendo relevantes. En un menú compacto, usa IDs estables para que el usuario pueda añadir, eliminar, renombrar o reordenar secciones, elegir su contenido de forma independiente y optar por elementos visuales individuales. Ofrece opciones ninguno, conservar, saltar, recomendar y opciones de texto libre cuando corresponda. Explica que recomendar delega la elección. Permite que el usuario decida el contenido y los elementos visuales independientemente de un ajuste predefinido.

Consume las elecciones que el usuario ya haya dado y consérvalas al revisar el esquema. Cuando conservar seleccione un elemento existente en un rediseño, preserva y aplica ese elemento. Pregunta solo por las decisiones de diseño no resueltas, agrupadas en un mensaje manejable. Espera esas decisiones antes de redactar un README nuevo o sustancialmente rediseñado, a menos que el usuario haya delegado las decisiones. Si el usuario dio suficiente dirección o te pidió que decidieras, continúa con valores predeterminados adecuados. Una vez que se resuelvan las decisiones, entrega el producto solicitado sin buscar otra aprobación. Para ediciones puntuales, ejecuta la solicitud del usuario directamente sin una nueva sesión del constructor.

Adapta este intercambio compacto al proyecto.

El orden propuesto es S1 Descripción general → S2 Inicio rápido → S3 Arquitectura. Las elecciones de contenido son S1 problema + alcance, S2 comandos mínimos y S3 mapa de componentes en texto plano. Las elecciones visuales son V1 captura de pantalla después de S1 (propuesta, ninguna disponible) y V2 diagrama de arquitectura después de S3 (propuesto). Elige secciones y orden, cambia el contenido de cualquier sección y elige elementos visuales individualmente. conservar acepta el valor propuesto específico, ninguno elimina una sección o elemento visual, saltar omite una elección opcional, y recomendar la delega. El texto personalizado es bienvenido.

El usuario elige orden S1, S3, S2 / S2 guiado / V1 ninguno / V2 conservar / conservar el resto.

El esquema resultante conserva el contenido de S1 y S3, usa inicio rápido guiado para S2, omite V1 y coloca V2 después de S3. Resuelve cualquier incertidumbre material restante sin reabrir elecciones aceptadas. Distingue los recursos propuestos de los recursos existentes. Crea u obtén un recurso propuesto solo dentro del alcance solicitado por el usuario y las herramientas disponibles, u omítelo y explica la brecha.

Producir y verificar

Redacta las secciones según el esquema elegido y los detalles específicos del proyecto. Verifica comandos de forma segura cuando sea práctico. Etiqueta comandos no verificados o información faltante, y evita ejecutar comandos destructivos o que tengan efectos secundarios solo para probar la documentación. Revisa el orden de los encabezados y los enlaces, anclas, la representación Markdown para la plataforma elegida, los bloques de código y las etiquetas de idioma, y las rutas relativas de los recursos. Proporciona texto alternativo informativo a las imágenes significativas y verifica la legibilidad en temas claro y oscuro cuando se usen elementos visuales. Conserva el contenido existente fuera del alcance solicitado. Informa sobre brechas materiales y limitaciones de verificación junto con el resultado.