diff --git a/docs/arquivos/casosdeuso.dia b/docs/arquivos/casosdeuso.dia new file mode 100644 index 0000000..81111b0 Binary files /dev/null and b/docs/arquivos/casosdeuso.dia differ diff --git a/docs/relatorios/etapa1/capa.tex b/docs/relatorios/etapa1/capa.tex index f40472d..be3d80a 100644 --- a/docs/relatorios/etapa1/capa.tex +++ b/docs/relatorios/etapa1/capa.tex @@ -9,11 +9,15 @@ \textsf{\vspace{6cm}} \begin{center} \noindent - \huge{ + \large{ \textbf{\titulo} } \\ + \Large{ \textbf{\subtitulo} + } \\ + \large{ + \textbf{APO-CASA} } \vspace{9cm} diff --git a/docs/relatorios/etapa1/capitulos/capitulo1.tex b/docs/relatorios/etapa1/capitulos/capitulo1.tex index ea29354..f358d0d 100644 --- a/docs/relatorios/etapa1/capitulos/capitulo1.tex +++ b/docs/relatorios/etapa1/capitulos/capitulo1.tex @@ -8,28 +8,27 @@ \section{Visão Geral} \label{sec:visaogeral} -O atual Sistema de Informações Gerenciais do Interlegis, ou SIGI, +O atual Sistema de Informações Gerenciais do Interlegis (SIGI) fornece um conjunto limitado de informações sobre as Casas Legislativas e não contempla a atual realidade do \emph{Programa Interlegis}. O sistema é executado em ambiente \emph{Microsoft Windows} utilizando -a plataforma \emph{Microsoft Access}, o qual possui uma série de -limitações tecnológicas, de manutenibilidade, e de acesso às -informações pelos usuários, bem como também o acesso através de outros -\textit{softwares}, gerando, neste caso, redundância e disparidade de -dados. +a plataforma \emph{Microsoft Access}, o qual possui limitações +tecnológicas, de manutenibilidade, e de acesso às informações pelos +usuários, bem como de acesso através de outros \textit{softwares}, +gerando, neste caso, redundância e disparidade de dados. Foi observado por parte dos usuários a necessidade de um sistema com interface \textit{web} e com uma \emph{base de dados} única e centralizada, tornando o acesso flexível e as informações atualizadas -refletindo diretamente nos outros sistemas do Interlegis. +refletindo diretamente nos demais sistemas do Interlegis. O novo sistema será desenvolvido utilizando a plataforma \emph{Python} com o framework de desenvolvimento \emph{Django}, o qual cumpre os requisitos necessários para a implementação do sistema. Além do mais, -o Django permitirá uma evolução natural do sistema e grande facilidade -na manutenção do mesmo. +o Django permitirá uma evolução natural do sistema e facilidade na +manutenção. O sistema, inicialmente, será dividido em 7 aplicações (ou componentes) Django: @@ -44,14 +43,14 @@ componentes) Django: \item \verb|sigi.apps.servicos| (Serviços) \end{enumerate} -Esta ``componentização'' permitirá o reaproveitamento dessas mesmas +Esta ``componentização'' permitirá o reaproveitamento dessas aplicações para outros projetos futuros do Interlegis baseado em Django. \subsection{Descrição das Atividades} Esta seção descreve as principais etapas de desenvolvimento do sistema -a serem cumpridas. Desde o planejamento e levantamento de requisitos -até a implantação do sistema e transferência de tecnologia à equipe do +a serem cumpridas. Desde o levantamento de requisitos até a +implantação do sistema e a transferência de tecnologia à equipe do Interlegis. \subsubsection{Primeira Etapa} @@ -67,14 +66,15 @@ Interlegis. \begin{enumerate} \item Codificação do sistema; \item Transformação do protótipo em interface para o sistema; -\item Implantação de sistema \textit{alpha} em um servidor de testes; +\item Implantação do sistema versão \textit{alpha} em um servidor de + testes; \item Avaliação final do sistema. \end{enumerate} \subsubsection{Terceira Etapa} \begin{enumerate} -\item Documentação do sistema desenvolvido; -\item Documentação dos parâmetros de configuração do sistema; +\item Documentação; +\item Documentação dos parâmetros de configuração; \item Manual de implantação (\textit{deployment}). \end{enumerate} diff --git a/docs/relatorios/etapa1/capitulos/capitulo2.tex b/docs/relatorios/etapa1/capitulos/capitulo2.tex index 0d26e03..b142140 100644 --- a/docs/relatorios/etapa1/capitulos/capitulo2.tex +++ b/docs/relatorios/etapa1/capitulos/capitulo2.tex @@ -14,27 +14,28 @@ O produto a ser desenvolvido deverá contemplar as seguintes funcionalidades: \begin{itemize} -\item Gerenciamento das informações das Casas Legislativas; -\item Gerenciamento de partidos políticos, parlamentares e seus - mandatos, e de legislaturas; -\item Gerenciamento de sessões legislativas, mesas diretora e de sua - composição partidária; -\item Gerenciamento de convênios das Casas Legislativas junto ao - Interlegis; -\item Gerenciamento dos equipamentos fornecidos e serviços prestados - às Casas Legislativas; -\item Conjunto de autorização e configuração de perfis de acesso ao +\item Gerenciamento das informações básicas de identificação das Casas + Legislativas; +\item Gerenciamento das informações sobre partidos políticos, + parlamentares, seus mandatos, e legislaturas; +\item Gerenciamento de sessões legislativas, mesas diretora e sua + composição; +\item Gerenciamento de convênios entre o Interlegis e as Casas + Legislativas; +\item Gerenciamento dos equipamentos e serviços disponibilizados para + as Casas Legislativas; +\item Conjunto de autorização e de configuração de perfis de acesso ao sistema; \item Permitir que o usuário efetue pesquisas no banco de dados utilizando filtros de seleção; -\item Permitir o ``rollback'' (recuo) das alterações em tempo de - edição dos dados; -\item Permitir a geração de relatórios em PDF dos dados estratégicos e - de pesquisas; -\item Manter o histórico das atividades com as Casas Legislativas. +\item ``Rollback'' (retorno) das alterações, em tempo de + edição dos dados, nos casos de falhas; +\item Geração de relatórios em PDF, dos dados estratégicos e + de resultados de pesquisas; +\item Manutenção do histórico das atividades com as Casas Legislativas. \end{itemize} -Deverá também ser considerado as seguintes características: +Considerar as seguintes características: \begin{itemize} \item Interface web compatível com os padrões e recomendações da World @@ -45,36 +46,27 @@ Deverá também ser considerado as seguintes características: acompanhamento da codificação; \item Ajuda \textit{online} e contextual do sistema; \item Instalação simplificada; -\item Sistema multi-usuário em rede concebido para a operacionalização - em três camadas distintas: apresentação (navegador web), aplicação e - dados. +\item Sistema multi-usuário em rede, concebido para operar em três + camadas distintas: apresentação (navegador web), aplicação e dados. \end{itemize} \subsection{Requisitos de Hardware} -Requisitos de \textit{hardware}necessários para que a aplicação -funcione corretamente: - \begin{itemize} -\item Aproximadamente 100 MB de espaço em disco; -\item Mínimo de 256 MB de memória RAM; -\item Processador compatível ao Pentium III ou superior; +\item Disco: 100 MB ou superior; +\item Memória RAM: 256 MB ou superior; +\item Processador: Pentium III ou superior; \end{itemize} \subsection{Requisitos de Software} -Requisitos de \textit{software} necessários para que a aplicação -funcione corretamente: - \begin{itemize} \item Sistemas operacionais GNU/Linux ou de família Unix BSD; -\item Apache 2 ou superior; -\item PostgreSQL 8.3 ou superior; -\item Python 2.5 ou superior (< 3.0); -\item Django 0.97-pre (trunk) ou 1.0. +\item Servidor web: Apache 2 ou superior; +\item SGBD: PostgreSQL 8.3 ou superior; +\item Linguagem/Interpretador: Python 2.5 ou superior (< 3.0); +\item Framework: Django 0.97-pre (trunk) ou 1.0. \end{itemize} \subsection{Requisitos de Performance} -Requisitos necessários para tirar o melhor proveito da aplicação: - \begin{itemize} \item Considerar o uso do sistema operacional GNU/Linux ou FreeBSD; \item Uso do servidor web Apache para a aplicação; @@ -84,22 +76,18 @@ Requisitos necessários para tirar o melhor proveito da aplicação: \end{itemize} \subsection{Requisitos de Documentação} -Documentação necessária que deverá vir a ser elaborada para servir de -suporte ao produto: - \begin{itemize} \item Documentação da \textit{Application Programming Interface} (API) do software; -\item Manual de configuração e implantação do sistema; +\item Manual de configuração e de implantação do sistema; \item Manual do usuário; \item Ajuda \textit{online} e contextual do sistema; \item Arquivos LEIA-ME e de licenciamento. \end{itemize} \subsection{Licenças} -O novo SIGI se baseia apenas em aplicações \emph{livres}, as quais -possuem um licenciamento sem nenhuma restrição de uso. A obtenção das -mesmas também são gratuitas. +O novo SIGI utiliza \emph{softwares livres}, os quais possuem um +licenciamento sem restrições de uso. Segue abaixo uma lista dos principais \emph{softwares} necessários para o desenvolvimento do SIGI e suas respectivas licenças: @@ -112,10 +100,10 @@ para o desenvolvimento do SIGI e suas respectivas licenças: \end{description} O SIGI será publicado como \emph{software livre} utilizando a licença -\textit{GNU General Public License (GNU GPL)} em sua versão 3, assim -como os outros produtos do Interlegis, e estará disponível no -repositório de \emph{software livre} Colab\footnote{Endereço web do - Colab: http://colab.interlegis.gov.br} do Interlegis. +\textit{GNU General Public License (GNU GPL)} em sua versão 3 e estará +disponível no repositório de \emph{software livre} +Colab\footnote{Endereço web do Colab: http://colab.interlegis.gov.br} +do Interlegis. % % Local variables: % mode: flyspell diff --git a/docs/relatorios/etapa1/capitulos/capitulo3.tex b/docs/relatorios/etapa1/capitulos/capitulo3.tex index 0e0d39c..97ec38e 100644 --- a/docs/relatorios/etapa1/capitulos/capitulo3.tex +++ b/docs/relatorios/etapa1/capitulos/capitulo3.tex @@ -13,9 +13,8 @@ Esta seção descreve a utilização do sistema através de \emph{Casos de Uso}, representando os principais atores e suas interações com o sistema. -Os Casos de Uso serve de auxílio à compreensão, por parte dos -usuários, de como o sistema tende a ser implementado e como é -pretendido que o mesmo venha a ser utilizado. +Os Casos de Uso servem de auxílio à compreensão dos usuários quanto à +implementação e uso do sistema. \subsection{Casos de Uso do SIGI} A Figura \ref{fig:casos} apresenta os Casos de Uso do SIGI de maneira @@ -24,20 +23,20 @@ simplificada. \begin{figure}[h] \centering \includegraphics[width=120mm]{../imagens/casosdeuso.png} - \caption{Casos de uso} + \caption{Casos de Uso} \label{fig:casos} \end{figure} \subsubsection{Descrição dos Atores} \begin{description} -\item[Funcionário Interlegis:] usuário apenas com atribuições de - leitura no sistema. -\item[Responsável pela Comunicação:] usuário da Subsecretaria de - Formação e Atendimento à Comunidade do Legislativo (SSFAC). -\item[Responsável pelo Convênio:] usuário do Serviço de Contratos e - Convênios (SCCO). -\item[Responsável pela Infra-estrutura:] usuário do Serviço de - Infra-estrutura Tecnológica (SEIT). +\item[Funcionário Interlegis Autorizado:] usuário apenas com + atribuições de leitura no sistema. Inclui pessoal da Subsecretaria + de Apoio Técnico e Relações Institucionais (SSATR) e Subsecretaria + de Planejamento e Fomento (SSPLF). +\item[SSFAC:] Subsecretaria de Formação e Atendimento à Comunidade do + Legislativo. +\item[SSADM:] Subsecretaria de Administração. +\item[SEIT:] Serviço de Infra-estrutura Tecnológica. \end{description} \subsubsection{Descrição das Atividades} @@ -46,6 +45,8 @@ simplificada. relatórios de diversas partes do sistema. \item[Emitir Etiquetas:] consiste em obter informações e emitir etiquetas de algumas partes do sistema. +\item[Pesquisar e Recuperar Informações:] habilidades de pesquisa e + obtenção de informações da base de dados do sistema. \item[Gerenciar Mesas Diretoras:] consiste em inserir, atualizar e remover \emph{Mesas Diretoras}, \emph{Sessões Legislativas} e modificar a \emph{Composição das Mesas Diretoras}. diff --git a/docs/relatorios/etapa1/capitulos/capitulo4.tex b/docs/relatorios/etapa1/capitulos/capitulo4.tex index 6bcf4d0..72f1068 100644 --- a/docs/relatorios/etapa1/capitulos/capitulo4.tex +++ b/docs/relatorios/etapa1/capitulos/capitulo4.tex @@ -9,9 +9,7 @@ \section{Modelo de dados} \label{sec:modelo} -\subsection{Diagrama de Entidade e Relacionamento} -Na Figura \ref{fig:er}, o diagrama do SIGI é apresentado. - +\subsection{Diagrama de Entidade e Relacionamento (figura \ref{fig:er})} \begin{figure}[p] \centering \includegraphics[width=120mm]{../imagens/er.png} @@ -20,10 +18,7 @@ Na Figura \ref{fig:er}, o diagrama do SIGI é apresentado. \end{figure} \subsection{Diagrama de Classes} -\subsubsection{Aplicação sigi.apps.casas} -Na Figura \ref{fig:casas} é apresentado o digrama de classes da -aplicação Django \verb|sigi.apps.casas|. - +\subsubsection{Aplicação sigi.apps.casas (figura \ref{fig:casas})} \begin{figure}[h] \centering \includegraphics[width=60mm]{../imagens/casas.png} @@ -31,10 +26,7 @@ aplicação Django \verb|sigi.apps.casas|. \label{fig:casas} \end{figure} -\subsubsection{Aplicação sigi.apps.contatos} -Na Figura \ref{fig:contatos} é apresentado o digrama de classes da -aplicação Django \verb|sigi.apps.contatos|. - +\subsubsection{Aplicação sigi.apps.contatos (figura \ref{fig:contatos})} \begin{figure}[h] \centering \includegraphics[width=120mm]{../imagens/contatos.png} @@ -42,10 +34,7 @@ aplicação Django \verb|sigi.apps.contatos|. \label{fig:contatos} \end{figure} -\subsubsection{Aplicação sigi.apps.convenios} -Na Figura \ref{fig:convenios} é apresentado o digrama de classes da -aplicação Django \verb|sigi.apps.convenios|. - +\subsubsection{Aplicação sigi.apps.convenios (figura \ref{fig:convenios})} \begin{figure}[h] \centering \includegraphics[width=100mm]{../imagens/convenios.png} @@ -53,10 +42,7 @@ aplicação Django \verb|sigi.apps.convenios|. \label{fig:convenios} \end{figure} -\subsubsection{Aplicação sigi.apps.inventario} -Na Figura \ref{fig:inventario} é apresentado o digrama de classes da -aplicação Django \verb|sigi.apps.inventario|. - +\subsubsection{Aplicação sigi.apps.inventario (figura \ref{fig:inventario})} \begin{figure}[h] \centering \includegraphics[width=120mm]{../imagens/inventario.png} @@ -64,10 +50,7 @@ aplicação Django \verb|sigi.apps.inventario|. \label{fig:inventario} \end{figure} -\subsubsection{Aplicação sigi.apps.mesas} -Na Figura \ref{fig:mesas} é apresentado o digrama de classes da -aplicação Django \verb|sigi.apps.mesas|. - +\subsubsection{Aplicação sigi.apps.mesas (figura \ref{fig:mesas})} \begin{figure}[h] \centering \includegraphics[width=145mm]{../imagens/mesas.png} @@ -75,10 +58,7 @@ aplicação Django \verb|sigi.apps.mesas|. \label{fig:mesas} \end{figure} -\subsubsection{Aplicação sigi.apps.parlamentares} -Na Figura \ref{fig:parlamentares} é apresentado o digrama de classes da -aplicação Django \verb|sigi.apps.parlamentares|. - +\subsubsection{Aplicação sigi.apps.parlamentares (figura \ref{fig:parlamentares})} \begin{figure}[h] \centering \includegraphics[width=100mm]{../imagens/parlamentares.png} @@ -86,10 +66,7 @@ aplicação Django \verb|sigi.apps.parlamentares|. \label{fig:parlamentares} \end{figure} -\subsubsection{Aplicação sigi.apps.servicos} -Na Figura \ref{fig:servicos} é apresentado o digrama de classes da -aplicação Django \verb|sigi.apps.servicos|. - +\subsubsection{Aplicação sigi.apps.servicos (figura \ref{fig:servicos})} \begin{figure}[h] \centering \includegraphics[width=60mm]{../imagens/servicos.png} diff --git a/docs/relatorios/etapa1/capitulos/capitulo5.tex b/docs/relatorios/etapa1/capitulos/capitulo5.tex index 928a46d..398d265 100644 --- a/docs/relatorios/etapa1/capitulos/capitulo5.tex +++ b/docs/relatorios/etapa1/capitulos/capitulo5.tex @@ -9,8 +9,9 @@ \section{Esquema de dados} \label{sec:esquema} -Nesta seção está disponível os esquemas do banco de dados \emph{SQL} -para cada aplicação do SIGI. +Nesta seção estão descritos os esquemas de criação das Entidades e de +seus relacionamentos do banco de dados \emph{SQL} para cada aplicação +do SIGI. \subsection{Aplicação sigi.apps.casas} \verbatiminput{../arquivos/casas.sql} diff --git a/docs/relatorios/etapa1/capitulos/capitulo6.tex b/docs/relatorios/etapa1/capitulos/capitulo6.tex index bf17044..1e5d938 100644 --- a/docs/relatorios/etapa1/capitulos/capitulo6.tex +++ b/docs/relatorios/etapa1/capitulos/capitulo6.tex @@ -9,6 +9,53 @@ \section{Protótipo de Interface Gráfica} \label{sec:prototipo} +\subsection{Tela de autenticação (login)} +O protótipo de interface para a autenticação no sistema pode ser +visualizado na Figura \ref{fig:login}. + +\begin{figure}[h] + \centering + \includegraphics[width=100mm]{../imagens/telalogin.png} + \caption{Tela para \textit{login} no sistema} + \label{fig:login} +\end{figure} + +\subsection{Dashboard} +Tela inicial do sistema após o \textit{login}, com informações gerais +e atividades recentes. + +Um protótipo do \textit{dashboard} (painel) pode ser visualizado na +Figura \ref{fig:dashboard}. + +\begin{figure}[h] + \centering + \includegraphics[width=120mm]{../imagens/dashboard.png} + \caption{\textit{Dashboard}} + \label{fig:dashboard} +\end{figure} + +\subsection{Tela de cadastro} +O protótipo de interface para o cadastro de informações pode ser +visualizado na Figura \ref{fig:cadastro}. + +\begin{figure}[h] + \centering + \includegraphics[width=120mm]{../imagens/cadastro.png} + \caption{Tela de cadastro} + \label{fig:cadastro} +\end{figure} + +\subsection{Tela de listagem de dados} +O protótipo de interface para o listagem de dados pode ser visualizado +na Figura \ref{fig:listagem}. + +\begin{figure}[h] + \centering + \includegraphics[width=120mm]{../imagens/listagem.png} + \caption{Tela para a listagem de dados} + \label{fig:listagem} +\end{figure} + % % Local variables: % mode: flyspell diff --git a/docs/relatorios/etapa1/capitulos/introducao.tex b/docs/relatorios/etapa1/capitulos/introducao.tex index eb7e723..6fceeaa 100644 --- a/docs/relatorios/etapa1/capitulos/introducao.tex +++ b/docs/relatorios/etapa1/capitulos/introducao.tex @@ -15,17 +15,17 @@ cidadãos nos processos legislativos. Um \emph{Sistema de Informações Gerenciais} é essencial para o Programa Interlegis, pois ajuda na tomada de decisões e mantêm um -controle das atividades com as Casas Legislativas. +controle das atividades realizadas com as Casas Legislativas. Atualmente, o Interlegis conta com um Sistema de Informações -Gerenciais limitado tanto tecnologicamente quanto operacionalmente, -por isso a necessidade de criação de um novo sistema atendendo as -demandas atuais e futuras do Programa. +Gerenciais que se encontra defasado em relação às necessidades atuais +do Interlegis, por isso a necessidade de criação de um novo sistema +para atender as demandas atuais e futuras de gestão do Programa. Este documento tem o propósito de detalhar as atividades desenvolvidas durante a primeira etapa do projeto de desenvolvimento do novo Sistema -de Informações Gerenciais do Interlegis (SIGI), tal como também -descrever as atividades futuras do projeto. +de Informações Gerenciais do Interlegis (SIGI), e também as atividades +futuras do projeto. A Seção \ref{sec:visaogeral} contém a \emph{visão geral} do sistema a ser desenvolvido e as principais etapas para a conclusão do sistema. @@ -45,7 +45,7 @@ relacionamentos entre as diversas partes do sistema, e o esquema do banco de dados. Na Seção \ref{sec:prototipo}, um protótipo de interface gráfica é -proposto e discriminado. +proposto. \subsection{Terminologia} \begin{description} @@ -59,15 +59,16 @@ proposto e discriminado. organização. \item[Framework:] no desenvolvimento de \textit{software}, um \textbf{framework} (ou arcabouço) é uma estrutura de suporte - definida em que um outro projeto de software pode ser organizado e + definida na qual um outro projeto de software pode ser organizado e desenvolvido. Frameworks são projetados com a intenção de facilitar o desenvolvimento de software, habilitando designers e programadores a - gastarem mais tempo determinando as exigências do software do que - com detalhes de baixo nível do sistema. + atuar mais tempo nas exigências do que nos detalhes de baixo nível + do sistema. \item[Django:] um framework de desenvolvimento web de alto nível - escrito em Python e que estimula o desenvolvimento rápido e limpo. + escrito em linguagem Python e que estimula o desenvolvimento rápido + e limpo. \end{description} % diff --git a/docs/relatorios/etapa1/comandos.tex b/docs/relatorios/etapa1/comandos.tex index 55b0c27..b714d4a 100644 --- a/docs/relatorios/etapa1/comandos.tex +++ b/docs/relatorios/etapa1/comandos.tex @@ -6,10 +6,10 @@ % See the file relatorio.tex for copying conditions. % -\newcommand{\titulo}{Relatório I} +\newcommand{\titulo}{Produto I} \newcommand{\subtitulo}{Sistema de Informações Gerenciais do Interlegis} \newcommand{\autor}{Guilherme Mesquita Gondim} -\newcommand{\numcontrato}{2008/XXXXXXX} % Número do contrato caso seja +\newcommand{\numcontrato}{2008/000471} % Número do contrato caso seja % consultor. % diff --git a/docs/relatorios/etapa1/imagens/apps.png b/docs/relatorios/etapa1/imagens/apps.png new file mode 100644 index 0000000..206e592 Binary files /dev/null and b/docs/relatorios/etapa1/imagens/apps.png differ diff --git a/docs/relatorios/etapa1/imagens/cadastro.png b/docs/relatorios/etapa1/imagens/cadastro.png new file mode 100644 index 0000000..d7be495 Binary files /dev/null and b/docs/relatorios/etapa1/imagens/cadastro.png differ diff --git a/docs/relatorios/etapa1/imagens/casosdeuso.png b/docs/relatorios/etapa1/imagens/casosdeuso.png index 783dd53..031ae90 100644 Binary files a/docs/relatorios/etapa1/imagens/casosdeuso.png and b/docs/relatorios/etapa1/imagens/casosdeuso.png differ diff --git a/docs/relatorios/etapa1/imagens/dashboard.png b/docs/relatorios/etapa1/imagens/dashboard.png new file mode 100644 index 0000000..f11e28f Binary files /dev/null and b/docs/relatorios/etapa1/imagens/dashboard.png differ diff --git a/docs/relatorios/etapa1/imagens/listagem.png b/docs/relatorios/etapa1/imagens/listagem.png new file mode 100644 index 0000000..21a95dd Binary files /dev/null and b/docs/relatorios/etapa1/imagens/listagem.png differ diff --git a/docs/relatorios/etapa1/imagens/telalogin.png b/docs/relatorios/etapa1/imagens/telalogin.png new file mode 100644 index 0000000..c4b92cd Binary files /dev/null and b/docs/relatorios/etapa1/imagens/telalogin.png differ