Cluedoc: skill de agente para criar documentação que ajuda a entender uma base de código
(keunwoopark.github.io)Você está cansado do código que os agentes de programação despejam? Acabou desistindo de entender seu próprio software?
Quando um agente escreve código, entendê-lo passa a ser a coisa mais importante. Se você não digitou uma única linha e a base de código continua mudando, como saber o que o sistema realmente faz e se a próxima alteração é segura? Mesmo que o agente faça o trabalho por você, é preciso ter uma compreensão mínima do sistema que está sendo criado para orientar o agente na direção certa.
Foi por isso que criamos o Cluedoc. O Cluedoc é um Agent Skill que faz agentes de programação escreverem documentos fáceis de ler por humanos. A documentação do Cluedoc foi feita para ser lida. Ela deixa de lado os detalhes técnicos e se concentra em conceitos de alto nível.
O Cluedoc vê o sistema como uma árvore de funcionalidades (features) e escreve um documento (paper) para cada funcionalidade. Os documentos ficam dentro da base de código como Markdown puro e são mantidos sempre atualizados dentro do loop de trabalho. Não precisa de servidor nem de banco de dados.
A própria landing page linkada é um documento do Cluedoc escrito sobre o Cluedoc. Também há exemplos de documentos gerados sobre Flask, Cobra e Commander; dê uma olhada.
Ainda não há comentários.