Base de conhecimento softwares:school:requisitos:documentacao_tecnica http://54.172.204.229/conhecimento/ 2026-04-20T17:42:12+00:00 FeedCreator 1.7.2-ppt DokuWiki Convenções de codificação do sistema 2017-02-14T11:38:23+00:00 2017-02-14T11:38:23+00:00 http://54.172.204.229/conhecimento/doku.php?id=softwares:school:requisitos:documentacao_tecnica:codigo&rev=1487072303 Propósito Estabelecer diretrizes que devem ser utilizadas durante a escrita e a manutenção do código-fonte do sistema. Descrição Nomes Constantes * Todas as constantes devem ter seus nomes escritos em letras maiúsculas; * Quando o nome de uma constante for composto por mais de uma palavra, estas devem estar separadas pelo caractere '_'; * Constantes que representam nomes de arquivos devem começar com 'NOME_...'; * Constantes que representam pastas devem começar com 'PASTA_...'; * … Documentação técnica 2017-02-14T11:30:37+00:00 2017-02-14T11:30:37+00:00 http://54.172.204.229/conhecimento/doku.php?id=softwares:school:requisitos:documentacao_tecnica:home&rev=1487071837 * Organização do repositório de código e dos arquivos do sistema * Convenções gerais de codificação do sistema * Convenções para a exibição de mensagens ao usuário * Convenções para a implementação de documentos impressos Convenções para a implementação de documentos impressos 2016-11-24T17:06:13+00:00 2016-11-24T17:06:13+00:00 http://54.172.204.229/conhecimento/doku.php?id=softwares:school:requisitos:documentacao_tecnica:impressao&rev=1480007173 Propósito Estabelecer as diretrizes básicas para a implementação de relatórios e outros documentos impressos pelo sistema. Descrição O estilo e as definições desse documento devem ser adotadas, na medida do possível, em todos os documentos impressos pelo sistema. Em alguns casos bem específicos o estilo de impressão poderá ser modificado, como no caso de documentos específicos de cada município/estabelecimento de ensino. Entretanto, mesmo nesses documentos, os aspectos técnicos da implementaç… Convenções para a exibição de mensagens ao usuário 2021-12-01T11:49:57+00:00 2021-12-01T11:49:57+00:00 http://54.172.204.229/conhecimento/doku.php?id=softwares:school:requisitos:documentacao_tecnica:mensagens&rev=1638359397 Propósito Estabelecer as diretrizes básicas para a exibição de mensagens ao usuário através de caixas de mensagem. Descrição Este documento define a forma como as mensagens devem ser exibidas ao usuário através de caixas de mensagem. A maioria das mensagens pode ser dividida em grupos bem específicos, e para cada grupo há regras que devem ser adotadas. As exceções à esses grupos também devem ser documentadas a fim de evitar um comportamento inadequado do sistema. Organização do repositório de código e dos arquivos do sistema 2016-11-24T17:09:21+00:00 2016-11-24T17:09:21+00:00 http://54.172.204.229/conhecimento/doku.php?id=softwares:school:requisitos:documentacao_tecnica:repositorio&rev=1480007361 Propósito Estabelecer uma estrutura padrão para a organização dos arquivos do projeto. Descrição Estrutura geral do repositório O repositório do sistema deve ser nomeado de acordo com o nome interno do produto (School) e dividido em uma série de pastas principais, conforme especificado a seguir: