prom 0

PROM 0 - Meta-PROM

PROM	0
Título	Meta-PROM
Autor	Gustavo Fonseca <gustavo.fonseca at scielo.org>
Revisor
Status	Rascunho
Data de criação	2015-07-27

Inspirado pelas PEPs da linguagem Python, PROM - forma contraída de Proposta de Melhoria - é um artefato de engenharia de software que contém a definição de um problema e sua solução. O principal objetivo por trás do uso das PROMs é o de separar os processos de engenharia de software e codificação, além de melhor documentar as decisões e design da aplicação.

Uma PROM deve conter, no mínimo, as seguintes seções:

1. Prefácio - Cabeçalho contendo metadado sobre a PROM, incluindo seu número, título resumido, autores, revisores, status e etc.
2. Resumo - Uma breve descrição do problema (aprox. 200 palavras).
3. Motivação - Descrição detalhada do problema.
4. Justificativa - Descrição detalhada da solução proposta. Deve incluir, quando for o caso, as motivações para a escolha de um determinado design, especificações de interfaces, análises de desempenho, exemplos de implementação em outras ferramentas e etc.