Pular para o conteúdo

Glossário

A própria tabela de termos do EIDOS.md, com ponteiros para esta documentação.

Termo O que é
produto O que você está definindo: um app, um livro, um estudo, qualquer coisa que o trabalho produza e tenha uma forma.
Framework (a estrutura) Como os arquivos são organizados: pastas, templates, propriedades, vocabulary, papéis. Vive em .eidos/; um Framework pode reger muitos produtos. →
raiz A pasta em que tudo vive. Encontrada pelo .eidos/ dentro dela, nunca pelo nome. →
pasta Uma pasta de nível superior na raiz, declarada com quem a possui: @eidos/collections para o padrão, @<tool>/<kind> para uma ferramenta, ninguém para a própria da pessoa. →
coleção Uma pasta possuída por @eidos/collections, contendo Blueprints de um mesmo tipo: specs, capítulos, investigações. Suas subpastas, se houver, são os seus grupos declarados. →
Blueprint (o plano) Um arquivo markdown em uma coleção, definindo uma unidade do produto por completo: propriedades em cima, corpo embaixo.
unidade O que um Blueprint define: uma spec, um capítulo, uma investigação. Os templates são nomeados por ela, no singular.
template (o modelo) O corpo que os Blueprints de uma coleção seguem: seções em ordem, sob nomes fixos. Só o corpo. Um arquivo por variant em .eidos/templates/. →
variant (a variante) Um dos templates de uma coleção, <unit>.<variant>.md. Um é o padrão; um Blueprint em outro diz isso em variant.
propriedade Um campo do frontmatter: nome, tipo, a quais coleções se aplica, se é obrigatória, significado e opções quando fechada. A tabela inteira são as propriedades do Framework. →
vocabulary (o vocabulário) A tabela de palavras do Framework usadas de propósito: o que cada uma significa e o que não é. →
documento de nível superior Um arquivo único na raiz, listado no documento do Framework. Sem template; o corpo nunca é validado.
papel Como um agente fala com um tipo de pessoa. .eidos/me.md diz qual papel está na cadeira. →
plugin A pasta própria de uma ferramenta, .eidos/plugins/<name>/, e qualquer pasta da raiz que ela possua. O padrão não lê nada disso. →
região Um trecho de um arquivo markdown que uma ferramenta possui, cercado por dois comentários HTML com o seu nome. →

Esta documentação também diz documento do Framework para .eidos/Framework.yaml, o único arquivo que declara o Framework, e frame (o enquadramento) para um Blueprint em uma coleção de enquadramento, um que descreve o produto inteiro. →

Não definido Por quê
specs, chapters, frames Nomes de coleções pertencem a um Framework.
## Intent, ## Out of Scope Nomes de seções pertencem a um template.
status, domain, tags O Eidos não define propriedades personalizadas. Cada uma é escolha de uma semente.
sprint, estimate, assignee Proibidos. Eles transformam um Blueprint em uma tarefa.