A documentação arquitetural precisa ser prescritiva e descritiva

A boa documentação arquitetural reduz os custos totais de um software reduzindo os esforços necessários para entender e justificar decisões do passado. Ela também fundamenta e acelera as decisões emergentes indicando quais constraints e condições permanecem relevantes. Assim, para cumprir seu propósito, a documentação arquitetural é, ao mesmo tempo, descritiva e prescritiva.

Bem feita, a documentação atende a diversos públicos com diferentes anseios e expectativas. Ela extrapola as fronteiras dos times técnicos, colaborando, por exemplo, para que o “negócio” identifique se a arquitetura atende a suas demandas, alinhando expectativas de qualidade e custo.

Para os times técnicos, a documentação arquitetural provê, por exemplo, evidências que facilitam a resolução dos trade-offs impostos por requisitos conflitantes, opções de design e de tecnologias. Ela também funciona como “memória” de como trade-offs foram resolvidos no passado. 

A documentação arquitetural deve impactar desde as atividades de desenvolvimento até a operação. Para testadores, por exemplo, ela indica os pontos críticos a testar indicando onde acontecem as “conexões” entre os diversos elementos. Já para o time de segurança, ela relaciona que aspectos relevantes ao tema que foram observados, bem como eventuais pontos de exploração e melhoria. Para os DBAs, a documentação indica onde dados são criados e consumidos. Para os desenvolvedores, ela delimita a autonomia para decisões de design e orienta a implementação.

De qualquer forma, é inegável, entretanto, que o principal beneficiado com a documentação arquitetural é o próprio arquiteto. Seja para lembrar seu posicionamento passado, seja para entender o trabalho de outro profissional.

Manter documentação arquitetural de qualidade implica em esforço de planejamento e disciplina de execução.

Compartilhe este insight:

Comentários

Participe deixando seu comentário sobre este artigo a seguir:

Subscribe
Notify of
guest
0 Comentários
Inline Feedbacks
View all comments

AUTOR

Elemar Júnior
Fundador e CEO da EximiaCo atua como tech trusted advisor ajudando empresas e profissionais a gerar mais resultados através da tecnologia.

NOVOS HORIZONTES PARA O SEU NEGÓCIO

Nosso time está preparado para superar junto com você grandes desafios tecnológicos.

Entre em contato e vamos juntos utilizar a tecnologia do jeito certo para gerar mais resultados.

Insights EximiaCo

Confira os conteúdos de negócios e tecnologia desenvolvidos pelos nossos consultores:

Arquivo

Pós-pandemia, trabalho remoto e a retenção dos profissionais de TI

CTO Consulting e Especialista em Execução em TI
EximiaCo 2024 - Todos os direitos reservados
0
Queremos saber a sua opinião, deixe seu comentáriox
()
x

Muito obrigado!

Deu tudo certo com seu envio!
Logo entraremos em contato
WEBINAR EXCLUSIVO
28/02 às 19:30

TENDÊNCIAS
EM TECNOLOGIA

2024

Quais são suas estratégias em tecnologia para este ano?

Neste webinar, Elemar Júnior e o time de consultores da EximiaCo irão apresentar as principais tendências em tecnologia para 2024 e como sua empresa pode atuar para aproveitar as melhores oportunidades.

A documentação arquitetural precisa ser prescritiva e descritiva

Para se candidatar nesta turma aberta, preencha o formulário a seguir:

A documentação arquitetural precisa ser prescritiva e descritiva

Para se candidatar nesta turma aberta, preencha o formulário a seguir:

Condição especial de pré-venda: R$ 14.000,00 - contratando a mentoria até até 31/01/2023 e R$ 15.000,00 - contratando a mentoria a partir de 01/02/2023, em até 12x com taxas.

Tenho interesse nessa capacitação

Para solicitar mais informações sobre essa capacitação para a sua empresa, preencha o formulário a seguir:

Tenho interesse em conversar

Se você está querendo gerar resultados através da tecnologia, preencha este formulário que um de nossos consultores entrará em contato com você:

O seu insight foi excluído com sucesso!

O seu insight foi excluído e não está mais disponível.

O seu insight foi salvo com sucesso!

Ele está na fila de espera, aguardando ser revisado para ter sua publicação programada.

Tenho interesse em conversar

Se você está querendo gerar resultados através da tecnologia, preencha este formulário que um de nossos consultores entrará em contato com você:

Tenho interesse nessa solução

Se você está procurando este tipo de solução para o seu negócio, preencha este formulário que um de nossos consultores entrará em contato com você:

Tenho interesse neste serviço

Se você está procurando este tipo de solução para o seu negócio, preencha este formulário que um de nossos consultores entrará em contato com você:

× Precisa de ajuda?