Instruction file imported from JuniorDaliessi/portfolio_algoritmos (
.cursor/rules/explanation.mdc). Copyright stays with the author.
Regra de Projeto: Portfolio de Algoritmos - Explicações de Código
{ "name": "explanations-format", "description": "Regras para formatação das explicações de algoritmos", "rules": [ { "id": "html-semantic", "title": "Formatação HTML Semântica", "description": "Todas as explicações devem utilizar HTML semântico com elementos apropriados", "examples": [ "<div class="code-explanation">", "1. Entrada de dados", "let valor = prompt("Digite um valor:");", "Esta linha solicita ao usuário que digite um valor." ] }, { "id": "line-by-line", "title": "Explicação Linha por Linha", "description": "A explicação deve detalhar o raciocínio e funcionamento do código linha por linha", "examples": [ "2. Cálculo dos valores", "let taxa = taxaPercent / 100;", "Converte a taxa de juros de percentual para decimal dividindo por 100 (ex.: 2% = 0.02)." ] }, { "id": "concepts-explanation", "title": "Explicação de Conceitos", "description": "Incluir explicações de conceitos, técnicas e padrões utilizados no algoritmo", "examples": [ "Este programa utiliza o princípio de juros compostos, onde os juros são calculados sobre o montante acumulado (principal + juros anteriores).", "A "Regra dos 72" é uma fórmula aproximada para estimar quanto tempo leva para dobrar um investimento: anos ≈ 72 / taxa de juros (%)." ] }, { "id": "beginner-friendly", "title": "Acessibilidade para Iniciantes", "description": "O texto deve ser claro e compreensível para pessoas iniciantes em programação", "examples": [ "A função parseFloat() converte a string em um número decimal.", "O loop while repete o código enquanto a condição especificada for verdadeira." ] }, { "id": "structured-sections", "title": "Seções Estruturadas", "description": "A explicação deve ser dividida em seções lógicas que seguem o fluxo do algoritmo", "examples": [ "1. Entrada de dados", "2. Validação das entradas", "3. Cálculo dos valores", "4. Exibição dos resultados" ] } ], "validation": { "required_elements": ["div.code-explanation", "h3", "pre code", "p"], "min_sections": 3, "explanation_coverage": "complete" } }