-
Notifications
You must be signed in to change notification settings - Fork 179
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Sections 8 to 12 translated to PT, fix section main, 1 and 5
- Loading branch information
Showing
8 changed files
with
128 additions
and
128 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,74 +1,74 @@ | ||
ifndef::imagesdir[:imagesdir: ../images] | ||
|
||
[[section-concepts]] | ||
== Cross-cutting Concepts | ||
== Conceitos Transversais | ||
|
||
|
||
ifdef::arc42help[] | ||
[role="arc42help"] | ||
**** | ||
.Content | ||
This section describes overall, principal regulations and solution ideas that are relevant in multiple parts (= cross-cutting) of your system. | ||
Such concepts are often related to multiple building blocks. | ||
They can include many different topics, such as | ||
.Conteúdo | ||
Esta seção descreve globalmente, as principais regulamentações e ideias de soluções que são relevantes em várias partes (= transversais) do seu sistema. | ||
Esses conceitos geralmente estão relacionados a vários blocos de construção. | ||
Eles podem incluir muitos tópicos diferentes, como | ||
* models, especially domain models | ||
* architecture or design patterns | ||
* rules for using specific technology | ||
* principal, often technical decisions of an overarching (= cross-cutting) nature | ||
* implementation rules | ||
* modelos, especialmente modelos de domínio | ||
* padrões de arquitetura ou _design patterns_ | ||
* regras para usar tecnologia específica | ||
* principais decisões, geralmente técnicas, de natureza abrangente (= transversais) | ||
* regras de implementação | ||
.Motivation | ||
Concepts form the basis for _conceptual integrity_ (consistency, homogeneity) of the architecture. | ||
Thus, they are an important contribution to achieve inner qualities of your system. | ||
.Motivação | ||
Os conceitos formam a base para a _integridade conceitual_ (consistência, homogeneidade) da arquitetura. | ||
Portanto, eles são uma contribuição importante para atingir as qualidades internas do seu sistema. | ||
Some of these concepts cannot be assigned to individual building blocks, e.g. security or safety. | ||
Alguns desses conceitos não podem ser atribuídos a blocos de construção individuais, por exemplo segurança ou proteção. | ||
.Form | ||
The form can be varied: | ||
.Forma | ||
A forma pode ser variada: | ||
* concept papers with any kind of structure | ||
* cross-cutting model excerpts or scenarios using notations of the architecture views | ||
* sample implementations, especially for technical concepts | ||
* reference to typical usage of standard frameworks (e.g. using Hibernate for object/relational mapping) | ||
* documentos conceituais com qualquer tipo de estrutura | ||
* trechos ou cenários de modelos transversais usando notações das visualizações de arquitetura | ||
* amostra de implementações, especialmente para conceitos técnicos | ||
* referência ao uso típico de _frameworks_ padrão (por exemplo, usando Hibernate para mapeamento de objeto/relacional) | ||
.Structure | ||
A potential (but not mandatory) structure for this section could be: | ||
.Estrutura | ||
Uma estrutura potencial (mas não obrigatória) para esta seção poderia ser: | ||
* Domain concepts | ||
* User Experience concepts (UX) | ||
* Safety and security concepts | ||
* Architecture and design patterns | ||
* "Under-the-hood" | ||
* development concepts | ||
* operational concepts | ||
* Conceitos de domínio | ||
* Conceitos de Experiência do Usuário (UX) | ||
* Conceitos de proteção e segurança | ||
* Padrões de arquitetura e _design patterns_ | ||
* Estruturas internas | ||
* Conceitos de desenvolvimento | ||
* Conceitos operacionais | ||
Note: it might be difficult to assign individual concepts to one specific topic | ||
on this list. | ||
Observação: pode ser difícil atribuir conceitos individuais a um tópico específico | ||
nesta lista. | ||
image::08-Crosscutting-Concepts-Structure-EN.png["Possible topics for crosscutting concepts"] | ||
image::08-Crosscutting-Concepts-Structure-EN.png["Tópicos possíveis para conceitos transversais"] | ||
.Further Information | ||
.Mais informações | ||
See https://docs.arc42.org/section-8/[Concepts] in the arc42 documentation. | ||
Veja https://docs.arc42.org/section-8/[Concepts] na documentação do arc42. | ||
**** | ||
endif::arc42help[] | ||
|
||
=== _<Concept 1>_ | ||
=== _<Conceito 1>_ | ||
|
||
_<explanation>_ | ||
_<explicação>_ | ||
|
||
|
||
|
||
=== _<Concept 2>_ | ||
=== _<Conceito 2>_ | ||
|
||
_<explanation>_ | ||
_<explicação>_ | ||
|
||
... | ||
|
||
=== _<Concept n>_ | ||
=== _<Conceito n>_ | ||
|
||
_<explanation>_ | ||
_<explicação>_ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,37 +1,37 @@ | ||
ifndef::imagesdir[:imagesdir: ../images] | ||
|
||
[[section-design-decisions]] | ||
== Architecture Decisions | ||
== Decisões Arquiteturais | ||
|
||
|
||
ifdef::arc42help[] | ||
[role="arc42help"] | ||
**** | ||
.Contents | ||
Important, expensive, large scale or risky architecture decisions including rationales. | ||
With "decisions" we mean selecting one alternative based on given criteria. | ||
.Conteúdo | ||
Decisões arquiteturais importantes, caras, de grande escala ou arriscadas, incluindo justificativas. | ||
Com "decisões", queremos dizer selecionar uma alternativa com base em critérios fornecidos. | ||
Please use your judgement to decide whether an architectural decision should be documented | ||
here in this central section or whether you better document it locally | ||
(e.g. within the white box template of one building block). | ||
Use seu julgamento para decidir se uma decisão de arquitetura deve ser documentada | ||
aqui nesta seção central ou se é melhor documentá-la localmente | ||
(por exemplo, dentro do modelo de caixa branca de um bloco de construção). | ||
Avoid redundancy. | ||
Refer to section 4, where you already captured the most important decisions of your architecture. | ||
Evite redundância. | ||
Consulte a seção 4, onde você já capturou as decisões mais importantes da sua arquitetura. | ||
.Motivation | ||
Stakeholders of your system should be able to comprehend and retrace your decisions. | ||
.Motivação | ||
As partes interessadas do seu sistema devem ser capazes de compreender e refazer suas decisões. | ||
.Form | ||
Various options: | ||
.Forma | ||
Várias opções: | ||
* ADR (https://cognitect.com/blog/2011/11/15/documenting-architecture-decisions[Documenting Architecture Decisions]) for every important decision | ||
* List or table, ordered by importance and consequences or: | ||
* more detailed in form of separate sections per decision | ||
* ADR (Architecture Decision Record) (https://cognitect.com/blog/2011/11/15/documenting-architecture-decisions[Documentando Decisões de Arquitetura]) para cada decisão importante | ||
* Lista ou tabela, ordenada por importância e consequências ou: | ||
* mais detalhada em forma de seções separadas por decisão | ||
.Further Information | ||
.Mais informações | ||
See https://docs.arc42.org/section-9/[Architecture Decisions] in the arc42 documentation. | ||
There you will find links and examples about ADR. | ||
Veja https://docs.arc42.org/section-9/[Architecture Decisions] na documentação do arc42. | ||
Lá você encontrará links e exemplos sobre ADR. | ||
**** | ||
endif::arc42help[] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,79 +1,79 @@ | ||
ifndef::imagesdir[:imagesdir: ../images] | ||
|
||
[[section-quality-scenarios]] | ||
== Quality Requirements | ||
== Requisitos de qualidade | ||
|
||
|
||
ifdef::arc42help[] | ||
[role="arc42help"] | ||
**** | ||
.Content | ||
This section contains all quality requirements as quality tree with scenarios. The most important ones have already been described in section 1.2. (quality goals) | ||
.Conteúdo | ||
Esta seção contém todos os requisitos de qualidade como árvore de qualidade com cenários. Os mais importantes já foram descritos na seção 1.2. (objetivos de qualidade) | ||
Here you can also capture quality requirements with lesser priority, | ||
which will not create high risks when they are not fully achieved. | ||
Aqui você também pode capturar requisitos de qualidade com menor prioridade, | ||
que não criarão altos riscos quando não forem totalmente alcançados. | ||
.Motivation | ||
Since quality requirements will have a lot of influence on architectural | ||
decisions you should know for every stakeholder what is really important to them, | ||
concrete and measurable. | ||
.Motivação | ||
Como os requisitos de qualidade terão muita influência nas decisões arquiteturais, | ||
você deve saber para cada parte interessada o que é realmente importante para eles, | ||
concreto e mensurável. | ||
.Further Information | ||
.Mais informações | ||
See https://docs.arc42.org/section-10/[Quality Requirements] in the arc42 documentation. | ||
Veja https://docs.arc42.org/section-10/[Quality Requirements] na documentação do arc42. | ||
**** | ||
endif::arc42help[] | ||
|
||
=== Quality Tree | ||
=== Árvore de qualidade | ||
|
||
ifdef::arc42help[] | ||
[role="arc42help"] | ||
**** | ||
.Content | ||
The quality tree (as defined in ATAM – Architecture Tradeoff Analysis Method) with quality/evaluation scenarios as leafs. | ||
.Conteúdo | ||
A árvore de qualidade (conforme definido no ATAM – Architecture Tradeoff Analysis Method) com cenários de qualidade/avaliação como folhas. | ||
.Motivation | ||
The tree structure with priorities provides an overview for a sometimes large number of quality requirements. | ||
.Motivação | ||
A estrutura de árvore com prioridades fornece uma visão geral para um número às vezes grande de requisitos de qualidade. | ||
.Form | ||
The quality tree is a high-level overview of the quality goals and requirements: | ||
.Forma | ||
A árvore de qualidade é uma visão geral de alto nível das metas e requisitos de qualidade: | ||
* tree-like refinement of the term "quality". Use "quality" or "usefulness" as a root | ||
* a mind map with quality categories as main branches | ||
* refinamento em forma de árvore do termo "qualidade". Use "qualidade" ou "utilidade" como raiz | ||
* um mapa mental com categorias de qualidade como ramos principais | ||
In any case the tree should include links to the scenarios of the following section. | ||
Em qualquer caso, a árvore deve incluir links para os cenários da seção a seguir. | ||
**** | ||
endif::arc42help[] | ||
|
||
=== Quality Scenarios | ||
=== Cenários de Qualidade | ||
|
||
ifdef::arc42help[] | ||
[role="arc42help"] | ||
**** | ||
.Contents | ||
Concretization of (sometimes vague or implicit) quality requirements using (quality) scenarios. | ||
.Conteúdo | ||
Concretização de requisitos de qualidade (às vezes vagos ou implícitos) usando cenários (de qualidade). | ||
These scenarios describe what should happen when a stimulus arrives at the system. | ||
Esses cenários descrevem o que deve acontecer quando um estímulo chega ao sistema. | ||
For architects, two kinds of scenarios are important: | ||
Para arquitetos, dois tipos de cenários são importantes: | ||
* Usage scenarios (also called application scenarios or use case scenarios) describe the system’s runtime reaction to a certain stimulus. This also includes scenarios that describe the system’s efficiency or performance. Example: The system reacts to a user’s request within one second. | ||
* Change scenarios describe a modification of the system or of its immediate environment. Example: Additional functionality is implemented or requirements for a quality attribute change. | ||
* Cenários de uso (também chamados de cenários de aplicação ou cenários de caso de uso) descrevem a reação do tempo de execução do sistema a um determinado estímulo. Isso também inclui cenários que descrevem a eficiência ou o desempenho do sistema. Exemplo: O sistema reage à solicitação de um usuário em um segundo. | ||
* Cenários de mudança descrevem uma modificação do sistema ou de seu ambiente imediato. Exemplo: Funcionalidade adicional é implementada ou requisitos para um atributo de qualidade mudam. | ||
.Motivation | ||
Scenarios make quality requirements concrete and allow to | ||
more easily measure or decide whether they are fulfilled. | ||
.Motivação | ||
Os cenários tornam os requisitos de qualidade concretos e permitem | ||
medir ou decidir mais facilmente se eles são atendidos. | ||
Especially when you want to assess your architecture using methods like | ||
ATAM you need to describe your quality goals (from section 1.2) | ||
more precisely down to a level of scenarios that can be discussed and evaluated. | ||
Especialmente quando você quer avaliar sua arquitetura usando métodos como | ||
ATAM você precisa descrever suas metas de qualidade (da seção 1.2) | ||
mais precisamente até um nível de cenários que podem ser discutidos e avaliados. | ||
.Form | ||
Tabular or free form text. | ||
Tabular ou texto livre. | ||
**** | ||
endif::arc42help[] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,27 +1,27 @@ | ||
ifndef::imagesdir[:imagesdir: ../images] | ||
|
||
[[section-technical-risks]] | ||
== Risks and Technical Debts | ||
== Riscos e Débitos Técnicos | ||
|
||
|
||
ifdef::arc42help[] | ||
[role="arc42help"] | ||
**** | ||
.Contents | ||
A list of identified technical risks or technical debts, ordered by priority | ||
.Conteúdo | ||
Uma lista de riscos técnicos identificados ou débitos técnicos, ordenadas por prioridade | ||
.Motivation | ||
“Risk management is project management for grown-ups” (Tim Lister, Atlantic Systems Guild.) | ||
.Motivação | ||
“Gerenciamento de riscos é gerenciamento de projetos para adultos” (Tim Lister, Atlantic Systems Guild.) | ||
This should be your motto for systematic detection and evaluation of risks and technical debts in the architecture, which will be needed by management stakeholders (e.g. project managers, product owners) as part of the overall risk analysis and measurement planning. | ||
Este deve ser seu lema para detecção e avaliação sistemáticas de riscos e débitos técnicos na arquitetura, que serão necessárias para as partes interessadas da gerência (por exemplo, gerentes de projeto, proprietários de produtos) como parte da análise geral de riscos e planejamento de medição. | ||
.Form | ||
List of risks and/or technical debts, probably including suggested measures to minimize, mitigate or avoid risks or reduce technical debts. | ||
.Forma | ||
Lista de riscos e/ou débitos técnicos, provavelmente incluindo medidas sugeridas para minimizar, mitigar ou evitar riscos ou reduzir débitos técnicos. | ||
.Further Information | ||
.Mais informações | ||
See https://docs.arc42.org/section-11/[Risks and Technical Debt] in the arc42 documentation. | ||
Veja https://docs.arc42.org/section-11/[Risks and Technical Debt] na documentação do arc42. | ||
**** | ||
endif::arc42help[] |
Oops, something went wrong.