Documento de requisitos de app: o que é a especificação de um app e por que você a aprova

A especificação de uma página que você aprova antes: capa do post do blog do Deployflix

Um documento de requisitos de app, ou especificação de app, é um plano curto e por escrito de um app antes de alguém construí-lo: quem vai usá-lo, as telas que cada pessoa vê, as informações que ele guarda, os serviços a que se conecta, o que fica de fora por enquanto e o valor máximo que a construção pode custar. Você lê, questiona e altera, e só quando ela descreve o app que você realmente quer é que você a aprova.

Você aprova antes porque a especificação é o lugar mais barato para encontrar um erro. Mover uma linha em uma página não custa nada. Descobrir depois da construção que os professores podem ver o telefone de todos os pais, ou que as mensalidades não podem ser pagas em parcelas, significa reconstruir.

O que é uma especificação de software, em palavras simples?

Em software, uma especificação (em projetos maiores, muitas vezes chamada de documento de requisitos, ou SRS, de software requirements specification) é o acordo entre quem precisa do app e quem vai construí-lo. Ela diz o que o app precisa fazer, não como o código faz isso. Para uma loja, um clube ou uma escola, uma página costuma bastar, desde que seja específica e em palavras simples.

O teste de uma especificação é simples: dois construtores diferentes conseguiriam lê-la e fazer mais ou menos o mesmo app? Se a página diz os alunos podem ver seus resultados, isso é um desejo. Se diz um aluno entra com o número de telefone e vê as notas das próprias provas, por matéria, ao lado da média da turma, isso é um requisito que alguém pode construir e você pode conferir.

O que entra em um documento de requisitos de app de uma página?

Pense em um centro de reforço escolar que quer um app para aulas, frequência e mensalidades. Uma especificação útil de uma página para ele tem estas partes:

Parte da especificaçãoO que ela dizExemplo para um centro de reforço escolar
Quem usaCada tipo de pessoa que entra no app e o que ela pode fazerDono, professores, alunos e pais; só o dono vê os totais das mensalidades
Telas por funçãoAs páginas que cada função vê e o que faz nelasProfessor: aulas do dia, registrar presença, lançar notas das provas. Pais: frequência, notas, mensalidades em aberto
Dados guardadosOs registros que o app armazena e o que cada um contémAlunos, aulas, presença por sessão, provas e notas, parcelas da mensalidade e recibos
IntegraçõesServiços externos a que ele se conecta, e comoPagamento on-line das mensalidades por um gateway de pagamento, com recibo para cada parcela
Deixado para depoisO que esta versão não vai fazerSem verificação de conflitos na grade horária; sem importação dos registros do ano passado
Teto de custoO valor máximo que a construção pode custarUm valor máximo mostrado antes da aprovação, não uma estimativa depois do trabalho

Telas por função é a parte que as pessoas leem por cima, e é a que mais importa. Um app, na verdade, são vários apps compartilhando um único conjunto de dados: a visão do dono, a do professor e a dos pais. Ler as telas função por função é como você percebe que um professor pode registrar a presença, mas ninguém pode corrigir um erro nela.

A linha deixado para depois é igualmente importante. Ela diz o que você não vai receber, que é a fonte habitual de decepção depois de uma construção. Uma lista curta e honesta de exclusões é sinal de uma boa especificação, não de uma fraca.

Quando você descreve um app para o Deployflix, a especificação que ele escreve segue este formato: quem usa o app, suas telas, os dados que ele guarda, o que fica de fora por enquanto e o valor máximo que a construção pode custar, no idioma em que você escreveu. Se algo na sua descrição não estiver claro, ele pergunta antes de planejar. Como funciona mostra onde a especificação entra entre os passos.

Como ler a especificação de um app e questioná-la?

Não leia uma especificação como um contrato, de cima a baixo. Leia como um dia no seu negócio.

  1. Percorra um dia real no papel de cada função. Onde a pessoa toca, o que ela vê, o que ela digita? Depois, faça o mesmo para cada uma das outras funções.
  2. Acompanhe um registro do começo ao fim. Escolha um único aluno, pedido ou agendamento. Quem o cria, quem o altera, quem pode excluí-lo e onde ele vai parar?
  3. Procure os caminhos que dão errado. Um agendamento cancelado, um reembolso, um lançamento errado, um pagamento que falha, um associado que sai. Se a especificação só descreve as coisas dando certo, pergunte o que acontece quando dão errado.
  4. Confira cada número e palavra que você imprimiria. Formatos de nota fiscal, parcelas da mensalidade, linhas de impostos e números de recibo devem corresponder ao jeito como você trabalha hoje. Se suas notas fiscais precisam mostrar um imposto como GST, IVA ou imposto sobre vendas, confira os detalhes com seu contador.
  5. Pergunte sobre tudo o que for vago. Palavras como gerenciar, acompanhar, fácil e relatórios escondem decisões. Pergunte: qual relatório, mostrando o quê, para quem?

Quais lacunas procurar antes de aprovar?

A maioria das especificações que dão errado não está errada; está incompleta. Estas são as lacunas que aparecem com mais frequência.

Quem pode ver o quê

É fácil dar nome às funções e deixá-las vagas. Verifique o que cada função pode ver, não só o que pode fazer. Um professor pode ver as mensalidades? Um pai pode ver as notas do filho de outra pessoa? Um funcionário pode baixar a lista de clientes? Se o app guarda informações pessoais, decida agora quem pode vê-las.

Editar, cancelar e desfazer

Todo registro vai precisar de correção um dia. Verifique se a especificação diz quem pode editar ou cancelar um lançamento e se o valor antigo é guardado.

Dinheiro

Se o app aceita pagamentos, a especificação deve mostrar as etapas: como os clientes podem pagar (cartões e meios de pagamento locais), o que está sendo pago, se é permitido pagar parte do valor, o que o cliente recebe depois e o que acontece quando o pagamento fica pendente ou falha. As regras de reembolso são uma decisão do negócio, então registre as suas por escrito. Os gateways costumam cobrar uma porcentagem por transação, acrescida de uma tarifa fixa em muitos países. Por isso, consulte a página de preços do seu gateway. Os apps do Deployflix recebem pagamentos por um gateway de pagamento como Razorpay ou Cashfree; gateways internacionais estarão disponíveis em breve. Nossa página de integrações mostra as conexões disponíveis hoje.

Mensagens e lembretes

Se você espera lembretes, diga como eles devem chegar às pessoas: por e-mail, dentro do app ou de outra forma. Se a especificação não menciona um canal, considere que ele não existe.

Seus dados atuais

Planilhas e cadernos antigos muitas vezes precisam ir para o novo app. Pergunte se trazê-los faz parte da especificação ou está na lista do que fica de fora.

Dispositivos e idiomas

As pessoas usarão o app em um celular, no computador do balcão da loja ou nos dois? Ele precisa estar disponível em espanhol, árabe, francês ou outro idioma, além do inglês? Essas escolhas definem as telas, então decida antes da construção. Deployflix escreve os textos do seu app no idioma que você solicitar e funciona em 41 idiomas.

Por que aprovar a especificação antes de qualquer construção?

Porque mudar uma frase é mais barato do que mudar um app. Antes da construção, acrescentar a função de pais ou uma parcela da mensalidade é uma edição em uma página. Depois da construção, a mesma alteração pode mexer em telas, dados e permissões que já estavam prontos.

Aprovar também lhe dá uma base para conferir o app pronto. Quando a construção terminar, abra a especificação e vá marcando item por item: cada função, cada tela, cada dado. Tudo o que estiver faltando é uma questão justa a levantar.

A especificação também define o custo antes de você se comprometer. Quando o custo máximo da construção está registrado na especificação, você decide com esse valor em mãos. No Deployflix, esse limite é exibido antes da sua aprovação, e você paga apenas pelo que a construção realmente consumiu, como explica a página de preços.

Como as alterações são planejadas depois que o app é construído?

Um app raramente fica pronto de vez. Um novo curso, uma segunda unidade, uma nova forma de cobrar as mensalidades: cada um merece o mesmo cuidado da primeira construção.

Planeje uma alteração como uma pequena especificação própria: o que muda, quais funções e telas ela afeta, quais dados são acrescentados ou alterados, o que continua igual e quanto ela pode custar. Leia com as mesmas perguntas e aprove antes de o trabalho começar. Guarde a versão anterior para que, se a alteração der errado, você possa voltar a uma que funcionava.

É assim que o Deployflix lida com alterações: você diz o que mudar, ele planeja a alteração como a próxima versão, e nada é construído até ela ser aprovada. Todas as versões anteriores são guardadas. Em uma organização, só podem aprovar as pessoas cuja função permite, como descreve a página de segurança.

Um modelo de especificação de app que você pode usar

Se você vai escrever sua própria especificação, copie estes títulos e preencha cada um com frases simples:

  • O app em uma frase: para quem ele é e que tarefa cumpre.
  • Funções: cada tipo de usuário e o que ele pode ver e fazer.
  • Telas por função: para cada função, as telas e o que acontece em cada uma.
  • Dados guardados: cada tipo de registro e as informações que ele contém.
  • Integrações: pagamentos, seu domínio, lojas de apps, onde o código fica guardado e tudo o mais a que ele se conecta.
  • Regras: mensalidades, limites, prazos, cancelamentos e reembolsos.
  • Deixado para depois: o que esta versão não vai fazer.
  • Teto de custo e aprovação: o valor máximo que pode custar e quem dá o aval.

Para exemplos práticos de funções, telas e dados, veja um sistema de gestão de turmas para cursosEN ou um app de agendamento para clínicaEN. Um fundador testando uma ideia pode manter a especificação ainda mais curta, com uma função, poucas telas e uma lista firme do que fica de fora, como em um app web MVP para startupEN.

Perguntas

Qual é a diferença entre uma especificação de app e um documento de requisitos?

Principalmente o tamanho e a formalidade. Um documento de requisitos de um projeto grande pode ter muitas páginas de requisitos numerados. Uma especificação de app para um pequeno negócio cobre os mesmos pontos (quem usa, o que faz, o que guarda) em uma página, em palavras simples.

Quem deve escrever a especificação do app?

A pessoa que conhece o negócio fornece o conteúdo: as funções, o trabalho do dia a dia e as regras. Um construtor pode transformar isso em uma especificação estruturada, mas só você pode dizer se ela está certa.

Posso alterar a especificação depois de aprová-la?

Sim. Trate isso como uma alteração: descreva o que mudou, leia o plano atualizado e aprove de novo. Guarde a versão anterior para poder comparar ou voltar atrás.

Qual deve ser o tamanho da especificação de um app?

Longa o bastante para que nada importante fique para adivinhação, e curta o bastante para que você leia tudo. Para a maioria dos apps de pequenos negócios, uma página é o certo; se ficar muito mais longa, pense em construir por etapas.

Descreva seu app

Escreva do que você precisa com suas palavras. O Deployflix escreve um plano de uma página com o custo e só constrói depois que você o aprova.