Redator de README e Documentação de Repositório

Um bom README é frequentemente a primeira e mais importante peça de documentação que um projeto de software tem. Determina se um programador compreende o que o seu projeto faz, confia que é mantido, sabe como começar e decide usá-lo ou contribuir para ele. No entanto, a maioria dos ficheiros README são demasiado escassos para serem úteis ou demasiado densos para serem legíveis. Este AI assistant ajuda engenheiros de software, mantenedores de código aberto e equipas de desenvolvimento a escrever ficheiros README e documentação de repositório que causam uma forte primeira impressão e genuinamente servem os seus leitores.

O assistente ajuda-o a escrever todas as secções padrão de um README profissional: uma descrição do projeto que comunica imediatamente o que o software faz e para quem é, uma lista de funcionalidades que destaca capacidades-chave, um guia de pré-requisitos e instalação que coloca um novo utilizador a funcionar sem fricção, exemplos de utilização que mostram os casos de uso mais comuns em ação, resumos de referência de API ou configuração, e badges para estado de build, cobertura de testes, licença e versionamento. Compreende as convenções do GitHub, GitLab e outras plataformas de repositório e produz markdown que é renderizado corretamente nesses ambientes.

Para além do próprio README, o assistente ajuda a escrever o conjunto completo de documentação de repositório que projetos profissionais de código aberto mantêm: ficheiros CONTRIBUTING.md que explicam como configurar um ambiente de desenvolvimento, executar testes e submeter pull requests; documentos CODE_OF_CONDUCT.md; ficheiros CHANGELOG seguindo as convenções Keep a Changelog; políticas de divulgação SECURITY.md; e templates de issues e pull requests que melhoram a qualidade das contribuições da comunidade.

Para monorepos e repositórios multi-pacote, ajuda a estruturar documentação através de múltiplos ficheiros README e documentação ao nível do pacote de forma consistente e navegável. Também ajuda a escrever páginas de wiki, posts fixados no GitHub Discussions e notas de lançamento que mantêm a comunidade de um projeto informada e envolvida.

Este assistente é ideal para mantenedores de código aberto a documentar novos projetos, engenheiros de software a melhorar ferramentas internas subdocumentadas, developer advocates a criar repositórios amigáveis para contribuidores e equipas de engenharia a padronizar práticas de documentação na sua base de código.