Sistema de Documentação do LAC

1. Conceito central

O que é o Sistema de Documentação do LAC

O sistema documental não é apenas uma pasta de arquivos nem um conjunto de manuais isolados. Ele é a capacidade permanente do LAC para registrar, organizar, relacionar, publicar, consultar, validar e preservar os documentos e artefatos que explicam, orientam, materializam e comprovam a existência e a evolução do sistema.

Definição: o Sistema de Documentação do LAC é a malha governada de documentos, registros, modelos, especificações, decisões, guias, páginas, códigos, dados e evidências que descrevem o LAC, orientam seu uso e desenvolvimento e preservam sua memória evolutiva.

Documentação do LAC

Explica o sistema, sua constituição, arquitetura, regras, operação e evolução.

Conteúdo do LAC

Apresenta objetos de conhecimento dos domínios atendidos, como matemática, filosofia e qualidade.

Artefatos técnicos

Materializam componentes por HTML, CSS, JavaScript, JSON, SQL, Cypher, imagens e outros formatos.

2. Para que serve

Finalidades do sistema documental

Compreender

Explicar identidade, propósito, conceitos, arquitetura e funcionamento do LAC.

Construir

Fornecer requisitos, modelos, especificações, padrões e critérios para desenvolver o sistema.

Operar

Orientar publicação, sincronização, observação, manutenção, recuperação e uso cotidiano.

Evoluir

Registrar demandas, Jornadas, decisões, versões, impactos, evidências e aprendizados.

3. Estrutura geral

Quatro dimensões que se cruzam

Cada documento é localizado por mais de uma dimensão. A pasta informa onde ele está; o tipo informa sua função; a arquitetura informa o objeto descrito; e a Jornada informa a mudança que lhe deu origem.

SISTEMA DE DOCUMENTAÇÃO DO LAC │ ├── Estrutura permanente │ ├── áreas e subáreas │ ├── tipos documentais │ ├── objetos documentados │ └── relações documentais │ ├── Estrutura evolutiva │ ├── demandas │ ├── Jornadas │ ├── decisões │ ├── versões │ └── estados │ ├── Estrutura de rastreabilidade │ ├── documento pertence à área │ ├── documento descreve objeto │ ├── Jornada cria ou altera documento │ ├── documento materializa componente │ ├── documento depende de documento │ └── documento substitui versão anterior │ └── Estrutura de acesso ├── índices ├── mapas ├── busca ├── páginas relacionadas └── grafos

4. Organização física

Como conversa com as áreas e subáreas da raiz

As pastas da raiz funcionam como áreas relativamente permanentes de responsabilidade. As subpastas especializam essas responsabilidades. A localização física deve refletir a função predominante do documento.

Área	Responsabilidade documental predominante	Pergunta respondida
`fundacao/`	Teoria, princípios, método, delimitação e elementos constitutivos.	Em que bases o LAC se sustenta?
`fundamentos/`	Conceitos, metamodelos, linguagens, categorias e relações normativas.	Quais conceitos orientam todo o LAC?
`arquitetura/`	Sistema, subsistemas, módulos, componentes, interfaces, dados e tecnologia.	Como o LAC está estruturado?
`projeto/`	Requisitos, soluções, especificações, protótipos, planos e critérios de aceitação.	O que será construído e como foi projetado?
`governanca/`	Políticas, decisões, Jornadas de evolução, mudanças, auditorias e evidências.	Como a evolução é autorizada e controlada?
`visitante/`, `aprendiz/`, `autor/`, `editorial/`	Orientações, responsabilidades, ferramentas e Jornadas dos papéis.	Como cada papel participa do LAC?
`conhecimento/` e `dominios/`	Objetos de conhecimento e conteúdos entregues pelo LAC.	Que conhecimento o LAC organiza e oferece?
`ferramentas/`	Utilitários, analisadores, calculadoras e visualizadores.	Que recurso apoia uma atividade?
`referencia/`	Fontes, livros, métodos e sistemas externos.	Em que fonte esta definição se apoia?
`assets/`	Imagens, estilos, scripts e dados utilizados pelas páginas e aplicações.	Que recurso materializa ou apresenta o conteúdo?

Regra: a estrutura de pastas não substitui a classificação conceitual. Um documento deve declarar também seu tipo, objeto, estado, origem, versão e relações.

5. Função documental

Tipos documentais utilizados pelo LAC

Constitutivos

teoria
princípios
propósito
delimitação
modelo de referência

Arquiteturais

arquitetura
modelo conceitual
modelo lógico
modelo físico
especificação de interface

Governança

política
decisão
Jornada
procedimento
matriz e auditoria

Orientação

índice
mapa
acolhimento
guia
tutorial

Conhecimento

objeto de conhecimento
explicação
knowgrama
atividade
glossário

Técnicos

HTML/CSS/JavaScript
JSON
SQL/Cypher
PNG/SVG
planilha e código

Distinção: pasta representa a área; tipo documental representa a função; objeto documentado representa aquilo que é descrito; artefato representa a materialização.

6. Relação transversal

Como a documentação conversa com as Jornadas

As áreas organizam verticalmente o acervo. As Jornadas atravessam horizontalmente essas áreas para realizar uma mudança, produzir entregas e atualizar a memória do LAC.

Demandaproblema, pergunta ou necessidade

Jornadaobjetivo, escopo e percurso

Atividadesanálise, decisão e construção

Documentosmodelos, páginas e registros

Validaçãocritérios e evidências

Implantaçãopublicação nas áreas

Memóriaversão, aprendizado e nova demanda

Da documentação para a Jornada

Fundamentos, arquitetura, políticas, modelos e registros anteriores oferecem contexto, limites, padrões e dependências.

Da Jornada para a documentação

A Jornada cria, altera, relaciona, valida, implanta, substitui ou descontinua documentos e artefatos.

Jornada não é apenas sua página. A página documenta a Jornada; a Jornada real inclui demandas, atividades, decisões, artefatos, validações, evidências e encerramento.

7. Uso ao longo do desenvolvimento

Como conversa com o ciclo de desenvolvimento do Sistema LAC

Fase	Documentação consumida	Documentação produzida ou atualizada
Demanda	Registros, lacunas, avaliações e contexto existente.	Registro da necessidade e decisão de abertura.
Análise	Fundamentos, arquitetura, políticas e documentos relacionados.	Diagnóstico, requisitos, regras e análise de impacto.
Modelagem	Requisitos, metamodelos e padrões.	Modelos conceituais, lógicos, físicos e especificações.
Construção	Especificações, contratos e critérios.	Componentes, páginas, códigos, dados e testes.
Integração	Interfaces, dependências e arquitetura.	Registros de integração e ajustes de contratos.
Validação	Critérios de aceitação e regras de qualidade.	Evidências, resultados, não conformidades e decisão.
Implantação	Plano, procedimento, inventário e versão.	Registro de publicação, paridade e reversão.
Avaliação	Métricas, ocorrências e retorno dos usuários.	Aprendizados, melhorias e novas demandas.

Princípio: a documentação é simultaneamente entrada, instrumento de controle, evidência e saída do ciclo de desenvolvimento.

8. Memória e relações

Rastreabilidade documental mínima

Cada documento controlado deve poder ser relacionado à sua origem, função, objeto, estado e dependências.

Documento
├── identificação
│   ├── título
│   ├── código, quando aplicável
│   ├── caminho
│   └── tipo documental
├── contexto
│   ├── área e subárea
│   ├── objeto documentado
│   ├── finalidade
│   └── público
├── evolução
│   ├── demanda de origem
│   ├── Jornada responsável
│   ├── versão
│   ├── estado
│   └── data de revisão
├── relações
│   ├── orientado por
│   ├── deriva para
│   ├── depende de
│   ├── substitui
│   ├── é substituído por
│   └── materializa
└── governança
    ├── autor ou responsável
    ├── aprovador
    ├── evidências
    └── condição de publicação

9. Participação humana e agentes

Papéis e responsabilidades no sistema documental

O sistema documental é utilizado, produzido e governado por diferentes papéis do LAC. Um mesmo participante pode exercer mais de um papel, mas as responsabilidades devem permanecer distinguíveis para preservar autoria, validação, decisão, publicação e rastreabilidade.

Princípio: quem utiliza um documento não é necessariamente quem o produz; quem o produz não é necessariamente quem o valida; e quem o valida não é necessariamente quem autoriza sua implantação.

Papéis quanto ao uso da documentação

Papel	Como utiliza a documentação	Documentos mais relevantes
Visitante	Consulta páginas de acolhimento, orientação, explicação inicial e navegação.	Guias de entrada, mapas, páginas introdutórias, perguntas frequentes e objetos de conhecimento.
Aprendiz	Utiliza conteúdos, percursos, atividades, exercícios, glossários e registros de progresso.	Objetos de conhecimento, knowgramas, jornadas de aprendizagem, atividades e referências.
Colaborador	Consulta padrões e contexto para sugerir correções, fontes, exemplos ou novos conteúdos.	Diretrizes editoriais, modelos, vocabulário, páginas relacionadas e registros de contribuição.
Autor	Usa fundamentos, arquitetura, modelos, requisitos e decisões para criar ou atualizar artefatos.	Modelos documentais, padrões, jornadas, arquitetura, requisitos e critérios de aceitação.
Curador	Verifica coerência, qualidade, atualidade, fontes, linguagem, classificação e relações.	Políticas editoriais, vocabulário, referências, critérios de qualidade e histórico de versões.
Mentor	Seleciona e contextualiza documentos conforme a necessidade e o nível do aprendiz.	Mapas, jornadas, níveis de profundidade, objetos relacionados e evidências de aprendizagem.
Gestor do LAC	Consulta documentação para priorizar demandas, acompanhar Jornadas, avaliar riscos e decidir implantação.	Painéis, matrizes, jornadas, relatórios, auditorias, decisões e mapas de dependência.
Operador	Usa procedimentos para publicar, sincronizar, monitorar, restaurar e manter ambientes.	Runbooks, rotinas, inventários, registros de implantação, auditorias e planos de recuperação.
Agente de IA	Consulta documentos autorizados para apoiar busca, classificação, recomendação, validação ou execução assistida.	Políticas de autorização, modelos, metadados, regras, contratos e bases de conhecimento permitidas.

Papéis quanto à geração e manutenção

Responsabilidade	Papel predominante	Resultado esperado
Identificar necessidade documental	Qualquer papel; consolidada pelo gestor	Demanda registrada e relacionada a uma Jornada.
Definir finalidade, público e escopo	Autor, gestor e responsável pelo domínio	Documento com função e limites explícitos.
Produzir ou atualizar conteúdo	Autor, especialista, colaborador autorizado ou agente assistente	Nova versão em elaboração, com fontes e relações indicadas.
Modelar estrutura e interfaces	Arquiteto ou responsável arquitetural	Coerência com sistema, subsistemas, módulos, componentes e dados.
Revisar qualidade e consistência	Curador e revisor	Correções, parecer e evidências de revisão.
Validar atendimento à demanda	Responsável pela Jornada e usuários representativos	Critérios de aceitação verificados.
Aprovar mudança relevante	Gestor ou instância de governança	Decisão registrada, com condições e impactos.
Publicar e implantar	Operador ou responsável autorizado	Versão implantada e registrada no ambiente correto.
Manter índices e rastreabilidade	Autor, curador e gestor documental	Mapas, índices, metadados e relações atualizados.
Avaliar uso e obsolescência	Gestor, curador, usuários e agentes autorizados	Decisão de manter, revisar, substituir ou descontinuar.

Matriz simplificada de responsabilidade

Atividade	Executa	Valida	Aprova	Usa ou consulta
Criar documento conceitual	Autor ou especialista	Curador e responsável conceitual	Gestor, quando normativo	Todos os papéis relacionados
Criar especificação técnica	Autor técnico ou arquiteto	Arquitetura e desenvolvimento	Gestor da mudança	Desenvolvedores, operadores e agentes autorizados
Criar orientação de uso	Autor, mentor ou especialista em UX	Curador e usuários representativos	Responsável pelo papel ou área	Visitante, aprendiz, autor ou gestor
Criar procedimento operacional	Operador ou responsável técnico	Outro operador e gestor	Responsável pela operação	Operadores e agentes autorizados
Alterar documento normativo	Autor designado	Curadoria, arquitetura e áreas afetadas	Governança do LAC	Toda a comunidade afetada

Responsabilidade dos agentes de IA: agentes podem apoiar busca, classificação, comparação, redação, verificação e atualização, mas devem operar conforme políticas de autorização, manter registro das ações e não assumir aprovação normativa ou implantação sem delegação explícita.

Relação com as Jornadas: cada Jornada deve declarar os papéis participantes, quem responde por cada entrega documental, quem valida, quem aprova e quem utilizará o resultado.

10. Controle documental

Estados, responsabilidades e regras

Estados recomendados

proposto em elaboração em validação aprovado implantado obsoleto

Responsabilidades

Autor produz; curador verifica coerência; gestor prioriza e controla; arquitetura valida posicionamento; operação implanta.

Regras essenciais

Evitar duplicação, preservar histórico, manter links, declarar dependências e registrar decisões relevantes.

Todo documento deve possuir finalidade e localização justificáveis.

Toda Jornada deve listar os documentos e artefatos criados, alterados ou substituídos.

Toda implantação deve registrar versão, ambiente, evidência e possibilidade de reversão.

Documentos obsoletos devem permanecer rastreáveis, mas não orientar o trabalho corrente.

Índices e mapas devem refletir o acervo implantado e não apenas o planejado.

11. Aplicação no estágio atual

Como implantar progressivamente este sistema documental

1. Inventariar

Localizar páginas, arquivos, imagens, dados, decisões e registros existentes.

2. Classificar

Atribuir área, subárea, tipo documental, objeto, estado e Jornada de origem.

3. Relacionar

Identificar dependências, derivações, versões, substituições e componentes materializados.

4. Governar

Atualizar índices, validar duplicações, implantar metadados e acompanhar pendências.

Situação atual: o LAC já possui documentação rica e distribuída, porém ainda apresenta rastreabilidade incompleta, estados nem sempre explícitos, documentos antigos próximos de versões novas e Jornadas que não listam integralmente seus artefatos.

Próximo artefato complementar: governanca/gestao_do_lac/mapa_documentacao_areas_jornadas_lac.html, destinado a inventariar documentos concretos, caminhos, tipos, estados e Jornadas relacionadas.

12. Síntese normativa

Formulação consolidada

O Sistema de Documentação do LAC é uma malha viva e distribuída de documentos e artefatos, organizada fisicamente pelas áreas e subáreas da raiz, classificada por tipos documentais e objetos, criada, atualizada, validada e implantada por Jornadas ao longo do ciclo de desenvolvimento e evolução, utilizada por visitantes, aprendizes, autores, curadores, gestores, operadores e agentes autorizados, e controlada pela governança por meio de papéis, estados, versões, responsabilidades, decisões e evidências.

ÁREAS E SUBÁREAS definem onde o documento pertence ↕ TIPOS DOCUMENTAIS definem para que o documento serve ↕ ARQUITETURA define o que o documento descreve ↕ JORNADAS definem por que e em qual mudança ele foi criado ↕ PAPÉIS E RESPONSABILIDADES definem quem produz, valida, aprova, publica e utiliza ↕ CICLO DE DESENVOLVIMENTO define em qual fase ele é usado ou produzido ↕ GOVERNANÇA define estado, validade, versão e responsabilidade

Relações documentais

Páginas relacionadas

Gestão do LAC Gestão de Demandas Internas Jornada Padrão de Evolução Rotina de Gestão de Mudanças Metamodelo Estrutural Modelo Conceitual de Referência Organização do LAC Mapa do Site Jornada do Autor