Desenvolvimento de Jogos: Como documentar seu cdigo

1 de 11

INICIAR

favorito (5)

Gostei (4)

http://www.devmedia.com.br/desenvolvimento-de-jogos-como-docum...

ASSINE MVP

imprimir

anotar

Baixe o APP

marcar como lido

Login

tirar dvidas

(0)

Anuncie | Loja | Publique | Assine | Fale conosco

Seja o primeiro de seus amigos a curtir isso.

Hospedagem web por Porta 80 Web Hosting

25/04/2016 10:13

Desenvolvimento de Jogos: Como documentar seu cdigo

2 de 11

INICIAR

http://www.devmedia.com.br/desenvolvimento-de-jogos-como-docum...

ASSINE MVP

Baixe o APP

Login

cdigos de alta complexidade, conveno de nomes, classes, variveis, etc. so pontos

importantes para um profissional da rea de criao ou manuteno de software. Alm dessas
caractersticas, necessrio que o profissional tenha outras qualidades que faro grande
diferena durante o andamento de um projeto, saber documentar desde a proposta at a
entrega do projeto, expor as ideias atravs de diagramas e fluxos. Elementos estes que
ajudaram durante os passos de uma equipe durante o incio do desenvolvimento ou durante
uma possvel manuteno, so importantes no desenvolvimento de qualquer tipo de sistemas, e
claro, no poderiam deixar de ser importantes no desenvolvimento de jogos. Neste artigo
mostraremos alguns elementos relevantes para uma boa documentao de projeto voltado para
jogos, uma breve representao da parte inicial de um projeto a partir da proposta, passando
por uma descrio de alguns diagramas e chegando ao incio da codificao. O objetivo desse
documento no um detalhamento de uma linguagem especfica, de um banco especfico e
sim as aptides necessrias para um bom andamento de um projeto de jogo, prticas e
situaes que so considerveis no desenvolvimento de qualquer sistema.

Conforme o decorrer desse jogo, cada fase alcanada ficar mais difcil, o jogo tem um perfil de
aventura com foco educativo; ser para plataforma web com elementos do mundo real. Este
jogo para fins acadmicos e no comerciais. Sero implementadas funcionalidades como
ranking de jogadores e para isso ser necessrio conexo com um bando de dados.

A principal vantagem desse jogo que ser de fcil entendimento e jogabilidade simples, onde
o nico objetivo fazer com que o personagem resgate o mximo de livros com suas limitaes
de andar para frente, para trs e saltar.

A primeira etapa de um projeto a proposta, momento onde exposta para o cliente qual a
inteno que levou a necessidade do desenvolvimento de um sistema. No PMBOK, que um
manual que descreve um universo de conhecimentos para gerenciamento de projetos, o
documento que representa esse momento o project charter. Vamos elencar os passos que
fazem parte desse documento.

25/04/2016 10:13

Desenvolvimento de Jogos: Como documentar seu cdigo

3 de 11

INICIAR

http://www.devmedia.com.br/desenvolvimento-de-jogos-como-docum...

ASSINE MVP

Baixe o APP

Login

envolvido no projeto, onde deve ser descrito exatamente como vai ser sua participao no
projeto, exemplo, quem o gerente do projeto, como ele vai integrar toda equipe, como ele vai
cumprir os prazos, etc.

Passo 2 - Escopo: descreve o objetivo metas e custos de todo o projeto. O objetivo descrever
exatamente qual inteno do jogo e o que o jogador ter que fazer para chegar aos limites do
jogo. Nas metas, descrever custos e prazos necessrios para a gerncia, requisitos,
desenvolvimentos, testes e encerramento do projeto.

Passo 3 - Premissas: informa o que indispensvel para a realizao de todo o trabalho.

Exemplo: equipamentos, infraestrutura, softwares e licenas necessrias.

Passo 4 - Riscos: a seguir, temos uma tabela simplificada com grupos de risco, suas
descries, e seus nveis (Tabela 1).

Nvel do
Grupo de Riscos

Descrio de riscos
Risco

Falta de dedicao total dos funcionrios envolvidos no projeto

Alto

Anlises e capturas de informaes erradas fornecidas pelo cliente

Baixo

Exceder o valor estimado para a concluso do projeto

Baixo

Solicitao de emprstimos

Baixo

Perda de colaboradores relacionados ao projeto

Mdio

Eliminao de pessoas de nvel hierrquico da empresa

Alto

Tempo suficiente para a homologao do Projeto

Mdio

Organizao

Fundos

Pessoal

Tempo

E se os fundos para o projeto estiverem comprometidos "O que pode

Riscos do

Baixo
garantir fundos adequados"?

Negcio

Riscos Tcnicos

No foram realizados os pr-requisitos para a implantao do sistema

Baixo

O escopo do projeto continua sendo aumentando.

Baixo

25/04/2016 10:13

Desenvolvimento de Jogos: Como documentar seu cdigo

4 de 11

INICIAR

http://www.devmedia.com.br/desenvolvimento-de-jogos-como-docum...

ASSINE MVP

Baixe o APP

Login

adaptao do sistema

Interface de difcil administrao e visualizao

Baixo

Falta de preparo tcnico dos funcionrios na utilizao do sistema

Mdio

A soluo de o sistema ser muito complexa para a organizao.

Baixo

Danos fsicos aos equipamentos de tecnologia

Mdio

Riscos da
Tecnologia

Dependncia de suporte tcnico de equipamentos com contrato de

Mdio
manuteno

Suporte com contrato de manuteno no possui componentes para

Riscos de

Alto
substituio

dependncia
Legalizao de licenas de softwares

Baixo

Comprometimento de entrega do hardware com os fornecedores

Alto

externa

Tabela 1. Descrio de Grupos de Risco no Desenvolvimento do Jogo (Project Management

Docs, 2013 - http://www.projectmanagementdocs.com/)

Passo 5 - Principais fases do projeto: so descritas na Tabela 2 as atividades e o prazo para

finalizao de cada uma. Assim podemos identificar o incio, como est o andamento, se houve
atrasos ou no e a finalizao de todo o projeto.

Tabela 2. Descrio das Atividades propostas para o desenvolvimento do jogo

25/04/2016 10:13

Desenvolvimento de Jogos: Como documentar seu cdigo

5 de 11

INICIAR

http://www.devmedia.com.br/desenvolvimento-de-jogos-como-docum...

ASSINE MVP

Baixe o APP

Login

gerente, o responsvel pelos custos, pelo escopo, riscos, qualidade, etc. Para cada rea deve
ser indicado o nome do principal envolvido.

Passo 7 - Comentrio: breve descrio sobre o desenvolvimento do projeto, no caso desse

documento trata-se da prtica em projetos de jogos - O jogo possui uma srie de controles e
processos que sero desenvolvidos dentro de um curto espao de tempo e com grande
qualidade e tecnologia para exceder as necessidades do patrocinador (sponsor) controlando de
forma gil o processo e proporcionando maior agilidade e qualidade dos participantes do jogo.

Passo 8 - Cenrio: conjunto de informaes que daro uma primeira viso do sistema, por
exemplo, na interface do sistema devem ser apresentadas as primeiras interfaces, momento
onde os patrocinadores tero suas primeiras percepes no que diz respeito ao jogo.

Passo 9 - Diagrama de casos de uso: neste caso demonstraremos um diagrama de casos de

uso para a proposta de desenvolvimento de um jogo. Esse diagrama mostra as atividades de
um ator dentro do ambiente do jogo, detalha quais as funcionalidades dele e o que o jogador
poder fazer dentro do jogo em questo (Figura 1).

25/04/2016 10:13

Desenvolvimento de Jogos: Como documentar seu cdigo

6 de 11

INICIAR

http://www.devmedia.com.br/desenvolvimento-de-jogos-como-docum...

ASSINE MVP

Baixe o APP

Login

Figura 1. Diagrama de Casos de Uso desenvolvido no contexto do jogo

Passo 10 - Diagrama de classes: representa as classes necessrias para o desenvolvimento do

sistema, muito til para o programador, pois simplifica a escrita do cdigo e incrementa as
funcionalidades descritas no diagrama de casos de uso. No incio do desenvolvimento de
qualquer sistema, isso uma fase muito importante, uma tima representao grfica dos
cdigos em orientao a objetos, e tambm um primeiro esboo das funcionalidades de um
programa, e claro, no poderia deixar de ser menos importante no desenvolvimento de um jogo
(Figura 2).

25/04/2016 10:13

Desenvolvimento de Jogos: Como documentar seu cdigo

7 de 11

INICIAR

http://www.devmedia.com.br/desenvolvimento-de-jogos-como-docum...

ASSINE MVP

Baixe o APP

Login

Figura 2. Diagrama de Classes desenvolvido no contexto do jogo

Passo 11 - Tabela de requisitos: trata-se da tabela com informaes e requisitos necessrios

para o funcionamento correto do sistema (Tabela 3). Funcionalidades estas que envolvem a
segurana do sistema (controle de acesso, validao de usurio, etc.), funcionalidades de
configurao, etc.

25/04/2016 10:13

Desenvolvimento de Jogos: Como documentar seu cdigo

8 de 11

INICIAR

http://www.devmedia.com.br/desenvolvimento-de-jogos-como-docum...

ASSINE MVP

Baixe o APP

Login

Tabela 3. Definio de Requisitos Funcionais e No-Funcionais Associados no Contexto do

Jogo, baseado no Processo Unificado UP (Wazlawick, 2013)

Passo 12 - Um sistema geralmente tem conexo com um bom banco de dados. O projeto inicial
de um BD feito atravs do Diagrama Entidade Relacionamento (DER). Com esse diagrama
em mos possvel entender o processo de normatizao do banco. Na Figura 3 temos um
simples DER com script SQL. No caso de um jogo simples, geralmente essas informaes s
dizem respeito parte de controle de acesso e andamento do jogo. Na figura consta a parte de
usurio e navegao no contexto do jogo.

Figura 3. Diagrama Entidade Relacionamento desenvolvido no contexto do jogo

Na Listagem 1 temos um script SQL para banco de dados MySQL, que implementa o diagrama

25/04/2016 10:13

Desenvolvimento de Jogos: Como documentar seu cdigo

9 de 11

INICIAR

http://www.devmedia.com.br/desenvolvimento-de-jogos-como-docum...

ASSINE MVP

Baixe o APP

Login

Listagem 1. Script SQL para criao das tabelas de banco de dados do jogo

CREATE SCHEMA IF NOT EXISTS `DBJogoEscola` DEFAULT CHARACTER SET utf8

COLLATE utf8_general_ci ;
USE `DBJogoEscola` ;
CREATE TABLE IF NOT EXISTS `DBJogoEscola`.`estagio ` (
`idestagio ` INT NOT NULL,
`fase` VARCHAR(8) NOT NULL,
`pontuacao ` INT NOT NULL,
`vidas ` INT NOT NULL, PRIMARY KEY (`idestagio `))
ENGINE = Inno DB;
CREATE TABLE IF NOT EXISTS `DBJogoEscola`.`save` (
`idsave` INT NOT NULL,
`data` DATETIME NOT NULL,
`descricao` VARCHAR(20) NOT NULL,
`idestagio ` INT NULL,
PRIMARY KEY (`idsave`),
INDEX `fk_save_estagio_idx` (`idestagio` ASC),
CONSTRAINT `fk_save_estagio `
FOREIGN

KEY (`ides tagio `)

REFERENCES `DBJogoEsco la`.`estagio` (`idestagio `)

ON DELETE NO ACTION
ON UPDATE NO ACTION)
ENGINE = Inno DB;
CREATE TABLE IF NOT EXISTS `DBJogoEscola`.`usuario` (
`idusuario ` INT NOT NULL,
`nome` VARCHAR(10 ) NOT NULL,
`ids ave` INT NULL,
PRIMARY KEY (`idus uario `),
INDEX `fk_usuario _save_idx` (`idsave` ASC),
CONSTRAINT `fk_usuario_save`
FOREIGN KEY (`idsave`)
REFERENCES `DBJogoEscola`.`save` (`ids ave`)
ON DELETE NO ACTION
ON UPDATE NO ACTION)
ENGINE = InnoDB;
SET SQL_MODE=@OLD_SQL_MODE;
SET FOREIGN_KEY_CHECKS=@OLD_FO REIGN_KEY_CHECKS;
SET UNIQUE_CHECKS=@OLD_UNIQUE_CHECKS;

Passo 13 - Para finalizar, na Figura 4 temos um fluxograma que trata-se de uma prtica que

25/04/2016 10:13

Desenvolvimento de Jogos: Como documentar seu cdigo

10 de 11

INICIAR

http://www.devmedia.com.br/desenvolvimento-de-jogos-como-docum...

ASSINE MVP

Baixe o APP

Login

um diagrama.

Figura 4. Fluxograma representando o funcionamento do jogo

Uma boa documentao reduz riscos em momentos iniciais do projeto e facilita a manuteno,
til tambm na integrao de novos profissionais. Boas prticas no desenvolvimento de
qualquer sistema so sempre bem vindas e lgico que as tcnicas no param por aqui, existem
muitas outras tcnicas e benefcios relacionados a cada um dos itens que discutimos aqui; este
artigo d apenas uma viso de uma pequena parte das prticas necessrias para um bom
desenvolvimento de um projeto.

Agradecimento especial ao professor do curso Dr.Juliano Schimiguel.

Referncias

DAMASCENO, R.R. Concepo do jogo educativo A Revolta da Cabanagem: enredo, cenrio,

interfaces, jogabilidade e udio. Disponvel em: http://www.larv.ufpa.br/downloads/academicos
/dissertao_ricardo.pdf . Acessado em 15/10/2013 s 10:50.

25/04/2016 10:13

Desenvolvimento de Jogos: Como documentar seu cdigo

11 de 11

INICIAR

http://www.devmedia.com.br/desenvolvimento-de-jogos-como-docum...

ASSINE MVP

Baixe o APP

Login

e-pmbok, Acessado em 26/10/2013.

WAZLAWICK, R. (2013). Anlise e Projeto de Sistemas de Informao Orientados a Objetos.

Disponvel em: www.lsc.ufsc.br/~edla/ine5624/materiais/!APSIOO-2LivroRaul.doc. Acessado em
18/11/2013 s 22:00.
Publicado no Canal Engenharia de software

por Anderson Queiroga

Engenharia de software lover

Ficou com alguma dvida?

No h comentrios

Postar dvida / Comentrio

Meus comentarios

25/04/2016 10:13