Skip to content

docs(produto): separa status do documento do status da implementacao - #715

Merged
karinaperes merged 1 commit into
developfrom
docs/estado-das-funcionalidades
Aug 18, 2026
Merged

karinaperes merged 1 commit into
developfrom
docs/estado-das-funcionalidades

Conversation

@karinaperes

@karinaperes karinaperes commented Aug 18, 2026 •

Copy link
Copy Markdown
Contributor

Pull Request

📋 Descrição

Cria um índice consolidado do estado das funcionalidades e separa, nos
documentos de produto, dois estados que hoje se confundem: o do documento e
o da implementação.

Motivação: não havia onde consultar o que já está no ar. Para decidir o que
construir em seguida era preciso abrir treze documentos e conferir cada um
contra o código.


🔗 Issue relacionada

Não há issue — lacuna identificada ao planejar as próximas funcionalidades.


✅ Alterações realizadas

  • Backend
  • Front-end
  • Banco de Dados
  • Testes
  • Documentação

Novo: docs/02 - produto/estado-das-funcionalidades.md

Índice das 15 funcionalidades com situação, o que falta e link para o documento
detalhado. Cada linha foi verificada contra as rotas de API, as telas e os
componentes — não é estimativa.

Inclui uma seção com as divergências encontradas entre documentação e código, e
o procedimento de manutenção: quem atualiza, quando e por quê.

Os 13 documentos de produto passam a declarar dois estados

**Status do documento:** Versão consolidada alinhada ao schema.prisma
**Status da implementação:** 🔴 não iniciada — API e exibição prontas, falta a tela de avaliação
**Estado consolidado:** ver estado-das-funcionalidades.md


O campo Status existente descrevia o estado do documento. "Versão
consolidada alinhada ao schema.prisma" diz que o texto bate com o banco — não
que exista tela. Sem um segundo campo, não havia como registrar
"especificado, backend pronto, interface pendente".

documento-0-visao-geral.md

aponta para o índice consolidado e explica a separação dos dois campos;
corrige a lista da Camada 2, que omitia Portfólio Público, Gestão de Skills, Gestão de Tech Stacks e Solicitação de Convite — quatro documentos que existem mas não estavam listados.
🧪 Como testar
Abrir docs/02 - produto/estado-das-funcionalidades.md e conferir a tabela da seção 3 contra o que você conhece da plataforma.
Verificar uma linha por amostragem — por exemplo, abrir /dashboard/feedbacks na aplicação e confirmar que é um placeholder.
Abrir qualquer documento de produto e checar os dois campos no cabeçalho.
Clicar nos links: do consolidado para os documentos, e de cada documento de volta para o consolidado.
📷 Evidências do levantamento
Situação verificada em 16/08/2026:


🟢 completa      8  autenticação, convites, solicitação de convite, skills,
                    tech stacks, painel administrativo, portfólio, perfil
🟡 parcial       3  projetos em equipe, certificados, jornada de entrada
🔴 não iniciada  3  feedback, dashboard do membro, conteúdos informativos
⚪ só documento  1  fórum
Telas que são placeholder (<UnderDevelopment />): /dashboard,
/dashboard/feedbacks, /dashboard/faq, /dashboard/forum.

⚠️ Observações
O feedback está mais avançado do que a documentação sugeria. Existem as
rotas de criação, listagem e agregação, o modelo no schema e a exibição no
portfólio público. Falta a tela onde a pessoa avalia o colega. Não é começar
do zero — é fechar um vão entre duas pontas já construídas.

/dashboard é a primeira tela que o membro vê ao entrar e é um
placeholder. Não existe documento de produto para ela, apenas o épico #630.
Vale considerar criar a documentação antes de implementar.

Três documentos divergiam do código, e estão listados no novo documento. A
causa não foi descuido: faltava campo para expressar implementação parcial.
O Documento 0, seção 4, trata divergência como falha de qualidade — a mudança
dá o instrumento para cumprir essa regra.

Este documento é índice, não fonte da verdade. A fonte é o código. Está
registrado no próprio arquivo que, ao encontrar divergência, corrige-se ali
e avisa-se — divergência costuma indicar que algo mudou sem passar pela
documentação.

Só documentação — nenhuma alteração de código, dependência ou configuração.

✔️ Checklist
 O PR está relacionado a uma Issue. (lacuna identificada no planejamento)
 O código foi testado. (links e codificação verificados; estados conferidos contra o código)
 Os testes existentes continuam passando. (só documentação)
 A documentação foi atualizada.
 Este PR resolve apenas um objetivo. (tornar visível o estado das funcionalidades)

<!-- This is an auto-generated comment: release notes by coderabbit.ai -->

## Summary by CodeRabbit

- **Documentação**
  - Adicionado um panorama consolidado do estado das funcionalidades, incluindo itens concluídos, parciais, não iniciados e pendências.
  - Documentados Convites de Acesso, Solicitação de Convite, Portfólio Público, Skills e Tech Stacks na Camada 2.
  - Atualizados documentos para distinguir status documental, status de implementação e estado consolidado.
  - Registradas lacunas, decisões pendentes e divergências entre documentação e disponibilidade atual da plataforma.


<!-- end of auto-generated comment: release notes by coderabbit.ai -->

@vercel

vercel Bot commented Aug 18, 2026

Copy link
Copy Markdown
Contributor

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
trycatch Ready Ready Preview Aug 18, 2026 1:09pm
trycatch-prod Ready Ready Preview Aug 18, 2026 1:09pm

@coderabbitai

coderabbitai Bot commented Aug 18, 2026 •

Copy link
Copy Markdown

Review Change Stack

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: c8c9584f-c690-4862-8420-d69ec6ebaf82

📥 Commits

Reviewing files that changed from the base of the PR and between 60a542d and 9914a34.

📒 Files selected for processing (15)
  • docs/00 - governanca/documento-0-visao-geral.md
  • docs/02 - produto/adminstrativo/painel-administrativo.md
  • docs/02 - produto/conteudos/conteudos-informativos-e-educacionais.md
  • docs/02 - produto/convite/invite-request.md
  • docs/02 - produto/convite/invite.md
  • docs/02 - produto/estado-das-funcionalidades.md
  • docs/02 - produto/feedback/feedback-reputacao.md
  • docs/02 - produto/jornada-de-entrada/jornada-de-entrada-how-to-join-ux.md
  • docs/02 - produto/jornada-de-entrada/jornada-de-entrada-how-to-join.md
  • docs/02 - produto/permissoes-papeis/permissoes.md
  • docs/02 - produto/portfolio/portfolio.md
  • docs/02 - produto/projetos/gestao-projetos.md
  • docs/02 - produto/skills/gestao-skills.md
  • docs/02 - produto/tech-stacks/gestao-stacks.md
  • docs/02 - produto/usuario/perfis-usuario.md

📝 Walkthrough

Walkthrough

The PR adds a consolidated functionality-status document and updates Layer 2 product documents with separate documentation, implementation, and consolidated-state metadata.

Changes

Documentation status governance

Layer / File(s) Summary
Status index and documentation contract
docs/00 - governanca/documento-0-visao-geral.md, docs/02 - produto/estado-das-funcionalidades.md
The Layer 2 index now includes additional product documents. The new status document records feature states, implementation gaps, pending decisions, documentation divergences, and maintenance procedures.
Product document status metadata
docs/02 - produto/adminstrativo/painel-administrativo.md, docs/02 - produto/conteudos/*, docs/02 - produto/convite/*, docs/02 - produto/jornada-de-entrada/*, docs/02 - produto/permissoes-papeis/permissoes.md, docs/02 - produto/portfolio/portfolio.md, docs/02 - produto/projetos/gestao-projetos.md, docs/02 - produto/skills/gestao-skills.md, docs/02 - produto/tech-stacks/gestao-stacks.md, docs/02 - produto/usuario/perfis-usuario.md
Product documents now separate document status, implementation status, and consolidated-state references. The entries record complete, partial, and unstarted implementation states.

Estimated code review effort: 2 (Simple) | ~10 minutes

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/estado-das-funcionalidades

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@karinaperes
karinaperes merged commit d4d90e7 into develop Aug 18, 2026
7 of 8 checks passed

This branch was successfully deployed

2 active deployments
Preview – trycatch-prod — 9914a347 Deployed Aug 18, 2026 by vercel[bot]
Preview – trycatch — 9914a347 Deployed Aug 18, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant