Você está na página 1de 10

Portal do Software Pblico Brasileiro

Logotipo do Sistema

Modelo de Manual de Instalao, Administrao e Uso do <nome do software>


Verso 1.0

Autores Nome dos integrantes

Local, xxxx de xxxxx

Modelo de Manual de Instalao, Administrao e Uso do <nome do software>

Portal do Software Pblico Brasileiro

Logotipo do Sistema

Sumrio
Licena deste Documento .........................................................................................................................3 Introduo ao Sistema XYZ......................................................................................................................4 Caractersticas e principais funcionalidades........................................................................................4 Arquitetura.................................................................................................................................................5 Instalao do Sistema................................................................................................................................6 Requisitos gerais para instalao..........................................................................................................6 Hardware mnimo necessrio...............................................................................................................6 Pr-requisitos........................................................................................................................................6 Passo-a-passo da Instalao no Sistema Operacional Linux...............................................................7 Atualizao do Sistema (Se necessrio)...............................................................................................8 Administrao e Uso do Sistema..............................................................................................................9 Link da Licena Jridica Creative Commons.........................................................................................10

Modelo de Manual de Instalao, Administrao e Uso do <nome do software>

Portal do Software Pblico Brasileiro

Logotipo do Sistema

Licena deste Documento Para a utilizao deste documento necessrio seguir as regras da licena Creative Commons pela mesma Licena 2.5 Brasil (http://creativecommons.org/licenses/by-ncsa/2.5/br/deed.pt_BR). Voc tem a liberdade de: Compartilhar copiar, distribuir e transmitir a obra.

Remixar criar obras derivadas. Sob as seguintes condies: Atribuio Voc deve creditar a obra da forma especificada pelo autor ou licenciante (mas no de maneira que sugira que estes concedem qualquer aval a voc ou ao seu uso da obra). Compartilhamento pela mesma licena Se voc alterar, transformar ou criar em cima desta obra, voc poder distribuir a obra resultante apenas sob a mesma licena, ou sob uma licena similar presente. Ficando claro que: Renncia Qualquer das condies acima pode ser renunciada se voc obtiver permisso do titular dos direitos autorais. Domnio Pblico Onde a obra ou qualquer de seus elementos estiver em domnio pblico sob o direito aplicvel, esta condio no , de maneira alguma, afetada pela licena. Outros Direitos Os seguintes direitos no so, de maneira alguma, afetados pela licena: Limitaes e excees aos direitos autorais ou quaisquer usos livres aplicveis; Os direitos morais do autor; Direitos que outras pessoas podem ter sobre a obra ou sobre a utilizao da obra, tais como direitos de imagem ou privacidade. Aviso Para qualquer reutilizao ou distribuio, voc deve deixar claro a terceiros os termos da licena a que se encontra submetida esta obra. A melhor maneira de fazer isso com um link para esta pgina.

Modelo de Manual de Instalao, Administrao e Uso do <nome do software>

Portal do Software Pblico Brasileiro Introduo ao Sistema XYZ

Logotipo do Sistema

Dever conter um texto introdutrio sobre o sistema em questo, sua mantenedora, etc. Exemplo: O CACIC um sistema de inventrio de hardware e software que tem a Dataprev como a mantenedora raiz e, atravs do Portal do SPB, recebe colaboraes das mais diversificadas formas e de diversas instituies. O sistema baseado em agentes sendo capaz de obter um diagnstico do parque computacional e fornecer informaes de diversos tipos de dispositivos e softwares presentes em um computador (estao ou servidor). Como exemplo de levantamento de dados computacionais cite-se unidades de cdrom, memria RAM, placas de rede, discos rgidos, softwares instalados entre outras funcionalidades. Caractersticas e principais funcionalidades Dever ser informado as caractersticas e funcionalidades do sistema como: arquitetura desenvolvida, banco de dados, etc. Exemplo: O cdigo fonte (que livre e aberto) est disponvel para ser baixado livremente no Portal do SPB e sua implementao em PHPTM, PythonTM e DelphiTM tendo como camada de armazenamento o sistema gerenciador de banco de dados MySQLTM. O sistema possui variadas funcionalidades entre as quais destacam-se: Suporte a inventrio em plataforma WindowsTM 32bits e a LinuxTM ; Obteno automatizada de dados de hardware e software ; Facilita o processo de levantamento patrimonial ; Suporte a mltiplos idiomas, sendo j existente o portugus brasileiro e espanhol (80%) e iniciada a traduo para o ingls, mas podendo ser facilmente traduzido para outros; Suporte ao controle de aquisies (licenas) de softwares adquiridos X inventariados; Integrao tecnologia Intel AMT/vProTM1 plugin desenvolvido e disponibilizado pela Intel para gerenciamento remoto de estaes de trabalho corporativas que contenham essa tecnologia embarcada .

Modelo de Manual de Instalao, Administrao e Uso do <nome do software>

Portal do Software Pblico Brasileiro Arquitetura

Logotipo do Sistema

Dever ser explicitado a arquitetura do sistema em questo contendo textos, figuras, fluxos, etc.

Modelo de Manual de Instalao, Administrao e Uso do <nome do software>

Portal do Software Pblico Brasileiro Instalao do Sistema Requisitos gerais para instalao

Logotipo do Sistema

Informar quais os requisitos de plataforma, softwares, servidores para instalao do sistema. Exemplo: 1. Um servidor com a sua distribuio GNU/Linux preferida. Aqui vamos usar a verso do Red Hat 5.0 onde ser instalado o Gerente do CACIC. Este mesmo guia pode ser utilizado para o CentOS e Fedora. Para as demais distribuies s adapt-lo. Praticamente todos os passos so iguais com as devidas particularidades da sua distribuio. 2. As estaes (computadores) em rede para que possa ser instalado um programa chamado Agente do CACIC. As estaes podem ser tanto Windows como Linux. Hardware mnimo necessrio Exemplo: Computador com processador Intel ou Amd. Memria RAM: 512MB RAM (2GB RAM recomendvel); HD: 15GB para instalar o GNU/Linux, o CACIC e a base de dados (50GB SCSI recomendvel)

Pr-requisitos Dever ser informado os pacotes/servios/componentes/softwares a serem instalados, endereo eletrnico para download e/ou passo-a-passo da instalao destes. Lembrando que nesse momento extremamente importante dar o devido suporte ao usurio, pois nem sempre so conhecedores de determinados processos de instalao. til a insero de printscreens das telas de instalao, detalhamento de comandos em terminais, diferenas entre sistemas operacionais, distribuies.

Modelo de Manual de Instalao, Administrao e Uso do <nome do software>

Portal do Software Pblico Brasileiro Passo-a-passo da Instalao no Sistema Operacional Linux

Logotipo do Sistema

Aqui dever conter o pass-a-passo do processo de instalao de forma detalhada, contendo imagens das telas de instalao, comandos com explicaes. Exemplo: Passo X: Configurao de conexo e base de dados para o sistema

Digite as informaes e clique no boto Teste de conexo para realizar o teste a mensagem de retorno deve ser como a abaixo.

Para criar a base de dados clique no boto Construir BD.

Observe que tudo foi concludo com sucesso e em seguida clique no boto Prximo.

Modelo de Manual de Instalao, Administrao e Uso do <nome do software>

Portal do Software Pblico Brasileiro Atualizao do Sistema (Se necessrio)

Logotipo do Sistema

Dever ser informado os passos para atualizao do sistema em questo, se necessrio. Caso esse item no se aplique, por favor desconsidere-o. Exemplo: As instrues que se seguem levam em conta as verses anteriores do CACIC na forma padro de disponibilizao, isto , a verso no foi alterada internamente na empresa usuria do CACIC. A atualizao para a verso do CACIC-2.4 tem trs pontos bsicos: Aplicao Gerente (servidor) Banco de dados Agentes

Observao: Antes de qualquer passo realize cpia de segurana (backup) de sua instalao atual (gerente, agentes, banco de dados). Atualizao do Gerente Em uma instalao de verso anterior existente (exemplo: /var/www/cacic2) ser necessrio sobrescrever os diretrios e arquivos existentes com a nova verso disponibilizada. Baixar a nova verso exemplo: CACIC2.4(Curumin)gerente2.4.0.7z Descompactar o contedo sobrescrevendo a instalao existente exemplo: # 7z x CACIC2.4(Curumin)gerente2.4.0.7z /var/www Nesse ponto a instalao do gerente estar atualizada para a nova verso. Atualizao do banco de dados A atualizao de banco de dados (MySQL) de verses anteriores devero utilizar os scripts criados especificamente para esse fim. Para cada verso disponibilizada oficialmente h um scripts (em formato sql) especfico de atualizao. Esses scripts esto disponveis no diretrio cacic2/instalador/sql do CACIC- gerente conforme exemplos a seguir cacic_jun2005.sql para atualizar a verso: Junho de 2005 cacic_fev2006.sql para atualizar a verso: Fevereiro de 2006 cacic_v2.2.2.sql para atualizar a verso: 2.2.2

Comandos bsicos para atualizao do banco de dados (em console mysql): Sintaxe: # mysql -u root NOME_BANCO_CACIC < nome_do_arquivo_sql_de_versao_atualizar

Modelo de Manual de Instalao, Administrao e Uso do <nome do software>

Portal do Software Pblico Brasileiro Administrao e Uso do Sistema

Logotipo do Sistema

Aqui dever ser descrito um how-to de como usar o sistema, configuraes adicionais, etc. Novamente, de extrema importncia o uso de imagens explicativas para facilitar a compreenso do usurio.

Modelo de Manual de Instalao, Administrao e Uso do <nome do software>

Portal do Software Pblico Brasileiro Link da Licena Jridica Creative Commons http://creativecommons.org/licenses/by-sa/2.5/br/legalcode

Logotipo do Sistema

Modelo de Manual de Instalao, Administrao e Uso do <nome do software>

10