Broklam/readme-constructor

Construtor de README

Construa um README que se encaixe no projeto e nos seus leitores. Trate o usuário como designer. As predefinições são propostas, e estrutura, conteúdo e elementos visuais são escolhas independentes. Use evidências do projeto e as decisões já tomadas pelo usuário. Nunca invente funcionalidades, comandos, resultados, imagens ou alegações.

Descobrir e propor

Inspecione o repositório relevante, a documentação existente, a fonte da documentação gerada e os ativos antes de propor uma receita. Identifique o propósito do README, o público-alvo, o título, o tom e o destino de renderização quando estes afetarem o design. Respeite um caminho de saída solicitado ou um rascunho apenas no chat. Edite a fonte da documentação quando a saída for gerada. Preserve fatos úteis e ativos existentes, especialmente em um README já existente.

Use os menus abaixo seletivamente. Seus padrões oferecem opções para o usuário adaptar. Seus exemplos vinculados são um subconjunto representativo selecionado do índice Awesome README, resumidos em breves notas originais. Nenhum acesso à rede é necessário para usar a skill.

• Use o menu de estrutura para propor um ponto de partida ordenado e escolhas de seções.
• Use o menu de conteúdo de seção para escolher o formato, a profundidade e as evidências para cada seção selecionada.
• Use o menu de elementos visuais para escolher visuais individuais, posicionamento e ativos disponíveis ou propostos.

Para um novo README ou reformulação completa, apresente uma receita personalizada e editável que mostre a ordem de cabeçalhos proposta, uma escolha de conteúdo para cada seção e quaisquer elementos visuais posicionados individualmente. Inclua breves opções de contexto apenas onde elas ainda forem relevantes. Em um menu compacto, use IDs estáveis para que o usuário possa adicionar, remover, renomear ou reordenar seções, escolher seu conteúdo de forma independente e optar por elementos visuais individuais. Ofereça none, keep, skip, recommend e opções de texto livre quando aplicável. Explique que recommend delega a escolha. Deixe o usuário decidir conteúdo e elementos visuais independentemente de uma predefinição.

Consuma as escolhas que o usuário já forneceu e mantenha-as ao revisar a receita. Quando keep selecionar um item existente em uma reformulação, preserve e aplique esse item. Pergunte apenas sobre as opções de design não resolvidas, agrupadas em uma mensagem gerenciável. Aguarde essas escolhas antes de redigir um novo README ou um README substancialmente reformulado, a menos que o usuário tenha delegado as decisões. Se o usuário deu orientação suficiente ou pediu que você decida, prossiga com padrões adequados. Uma vez resolvidas as escolhas, entregue o solicitado sem buscar outra aprovação. Para edições pontuais, execute diretamente a solicitação do usuário sem uma nova sessão do construtor.

Adapte esta troca compacta ao projeto.

A ordem proposta é S1 Visão geral → S2 Início rápido → S3 Arquitetura. As escolhas de conteúdo são S1 problema + escopo, S2 comandos mínimos e S3 mapa de componentes em texto simples. As escolhas visuais são V1 captura de tela após S1 (proposta, nenhuma disponível) e V2 diagrama de arquitetura após S3 (proposto). Escolha seções e ordem, altere o conteúdo de qualquer seção e escolha elementos visuais individualmente. keep aceita o valor proposto específico, none remove uma seção ou visual, skip deixa uma opção opcional de fora e recommend delega a decisão. Texto personalizado é bem-vindo.

Usuário escolhe order S1, S3, S2 / S2 guiado / V1 none / V2 keep / manter o resto.

A receita resultante mantém o conteúdo de S1 e S3, usa início rápido guiado para S2, omite V1 e posiciona V2 após S3. Resolva qualquer incerteza material restante sem reabrir escolhas aceitas. Distinga ativos propostos de ativos existentes. Crie ou obtenha um ativo proposto apenas dentro do escopo solicitado pelo usuário e das ferramentas disponíveis, ou omita-o e explique a lacuna.

Produzir e verificar

Escreva as seções de acordo com a receita escolhida e com os detalhes específicos do projeto. Verifique comandos com segurança quando prático. Rotule comandos não verificados ou informações ausentes e evite executar comandos destrutivos ou com efeitos colaterais apenas para testar a documentação. Verifique a ordem dos cabeçalhos e links, âncoras, renderização Markdown para a plataforma escolhida, fences de código e tags de idioma, e caminhos relativos de ativos. Forneça texto alternativo informativo para imagens significativas e verifique a legibilidade em temas claro e escuro quando elementos visuais forem usados. Preserve o conteúdo existente fora do escopo solicitado. Relate lacunas materiais e limites de verificação junto com o resultado.