Manual Padrões Construção Websites

download Manual Padrões Construção Websites

of 7

Transcript of Manual Padrões Construção Websites

  • 8/17/2019 Manual Padrões Construção Websites

    1/7

    Manual de Padrões de Construçãode Websites (MPCW)

    11/03/2005

  • 8/17/2019 Manual Padrões Construção Websites

    2/7

    INDICE

    INDICE.............................................................................................................2

    OBJETIVO.........................................................................................................3

    ESTRUTURA DE PASTAS.........................................................................................3

    NOMENCLATURA DE ARQUIVOS...............................................................................3

    Default......................................................................................................4Formulários................................................................................................4

    NÚCLEO...........................................................................................................4

    Pasta IMGS.................................................................................................4Pasta INCS..................................................................................................5Pasta SWF ..................................................................................................5Pasta JS.....................................................................................................5Pasta CSS...................................................................................................5Pasta TEMPLATES...........................................................................................

    MODELOS.........................................................................................................6

    DOCUMENTAÇÃO................................................................................................7

     Ar!ui"os e Pastas........................................................................................# C$%i&o.......................................................................................................# 

  • 8/17/2019 Manual Padrões Construção Websites

    3/7

    Obje!"#

    Este documento tem como obeti!o traçar e "ormular #adrões e re$ras #ara odesen!ol!imento de Websites%

    & #adroni'ação #ermite maior #roduti!idade maior $rau de reutili'ação uni"ormidadede cdi$o acess*!el a todos os membros da e+ui#e de desen!ol!imento e um bai,o custode manutenção #ara o cliente% - #adrão interno de desen!ol!imento consolidado resultaem uma maior +ualidade dos #rodutos desen!ol!idos%

    Este documento tem como obeti!o tamb.m tra'er um maior entrosamento entre osinte$rantes das e+ui#es de desen!ol!imento l*deres de #roeto analistas de sistemasanalistas de sistemas trainee etc%

    E$%&&%' (e P'$'$

    Para manter a uni"ormidade de todos os #roetos eb os sites desen!ol!idos #ela E&de!erão ter a se$uinte estrutura de #astas na rai' do site

    P'$' )&*+,#Ca#a Conter os ar+ui!os relacionados com a ca#a do Website4cleo Conter as sub#astas incs im$s css s s" e tem#lates%nomedaarea6 Conter os ar+ui!os relacionados com a 7rea%

    8 as #astas Ca#a e nomedaarea6 #odem conter as sub#astas da #asta n4cleo casoe,istam ar+ui!os +ue s essa 7rea use ou necessite%

    8 o caso do #roduto Portal . usado em cada 7rea a #asta n4cleo com as sub#astas%

    N#-e*/'&%' (e A%0&!"#$

    - ar+ui!o #adrão ter7 o nome de"ault% Esse ar+ui!o estar7 na rai' do Website e nas#astas nomedaarea6% Caso a 7rea conten9a !7rios *tens essas #7$inas de!erão ter anomenclatura de acordo com o conte4do%

    E,% 

    In s ti tu c io n a l

    H i s t ó r i c o

    O r g a n o g r a m a

    F a le C o n o s c o

    E m p r e s a

  • 8/17/2019 Manual Padrões Construção Websites

    4/7

    Caso o de"ault da 7rea não ten9a conte4do ele #oder7 ser eliminado "icando s osar+ui!os relacionados aos itens da 7rea%

    De1'&/

    - de"ault do Website de!er7 ser uma #7$ina com dois "rames um c9amando ca#a/blan:

    e outro c9amando ca#a/de"ault%

    )#%-&/%!#$&s nomenclaturas das #7$inas de "ormul7rio de!erão ser da se$uinte "orma

    • Caso a 7rea sea s do "ormul7rio ;e"ault < #7$ina com o "ormul7rio ;one < #7$ina de res#osta de sucesso

    • Caso a #7$ina sea um item de uma 7rea nomedo"ormulario6 = #7$ina com o "ormul7rio nomedo"ormulario6>done < #7$ina de res#osta de sucesso

    8 as #7$inas de cadastro de!erão ser uma 7rea e as #7$inas terão a nomenclatura deacordo com o conte4do da #7$ina e a #7$ina de"ault%

    /#b'/

    P'$' IMS&s ima$ens relacionadas com o Website estarão nessa #asta% & #asta im$s #oder7 serusada como sub#asta de uma 7rea caso ela necessite (se as ima$ens estão diretamenterelacionadas com a 7rea e não serão usadas em outra 7rea do Website)%

    & nomenclatura das ima$ens "ica a car$o do Webdesi$ner sendo +ue al$umas ima$ensterão de ter a nomenclatura #adrão%

      5 - #, . uma ima$em de 1,1 #i,el trans#arente%

      5*8 ? uma ima$em de 1,1 #i,el sendo +ue !ariando a cor% n6 . umn4mero crescente +ue começa de 01%

      b9  Essa ima$em est7 relacionada com o bac:$round da #7$ina% &nomenclatura ser7 b$@"uncao6@#osição e/ou numeração6%

    N#-e (' )&*+,# )&*+,#menu Ama$em relacionada com o menuc9am Ama$em relacionada com as c9amadasbodB Ama$em relacionada com o bac:$round da #7$inad Ama$em relacionada a c.lula da tabelait Ama$em relacionada com o t*tulobo, Ama$em relacionada com a tabela

  • 8/17/2019 Manual Padrões Construção Websites

    5/7

      !  Ama$em relacionada com o t*tulo de uma #7$ina% & nomenclatura ser7tit@nomedot*tulo6%

      e$e*8 Essa ima$em . utili'ada #ara #reenc9er o laBout #ara !i'uali'açãoe não ser7 utili'ada de#ois% endo assim na 9omolo$ação do Website essasima$ens de!erão ser a#a$adas do ser!idor% n6 . um n4mero crescente +uecomeça de 01%

    -utras ima$ens #oderão "icar a car$o do Webdesi$ner dar o mel9or nome #araidenti"ica=las%

    P'$' INCSessa #asta !ão "icar os includes do Website% ? "unção do Webdesi$ner !eri"icar a mel9or"orma de usar os includes #ara "acilitar a manutenção ou im#lementação do sistema%

    8 o caso es#ec*"ico do DC tudo +ue ser7 $erado #elo sistema de!er7 ser "eito uminclude%

    &l$uns includes im#ortantes to#o roda#. menu c9amadas lo$omarca assinatura eoutros%

    & nomenclatura dos includes "ica de acordo com a "unção% emos ti#os de includes

    Anclude de#7$ina

    Est7 relacionado ao conte4do da #7$ina% & nomenclatura de!er7 sercont@nomeda#a$ina6% Esse include "icar7 na #asta inc da 7rea dessa#7$ina%

    Anclude dec9amada

    Est7 relacionado as c9amadas do Website ele "ica na #asta inc da7rea da #7$ina% e o include "or usado em outra 7reas do site ele

    "icar7 na #asta incs no n4cleo do Website%Anclude de laBout -s includes de laBout são usados no Website inteiro tem a "unção dese#arar #artes do laBout #ara "acilitar a manutenção% E,% o#oroda#. assinatura menu%

    Anclude de!ari7!eis

    o n4cleo do Website de!er7 conter o ar+ui!o de !ari7!eis +uecontem as !ari7!eis +ue serão usadas no Website% - ar+ui!o se c9ama!ari7!eis% o caso de canais de #ortais usa=se o !ari7!eis do #ortal e o!ar@canal%

    P'$' S:)essa #asta !ai conter todos os ar+ui!os Flas9% & nomenclatura "ica de acordo com a

    "unção do ar+ui!o%

    P'$' JSessa #asta !ai conter todos os ar+ui!os de Ga!acri#t% & nomenclatura "ica de acordocom a "unção do ar+ui!o%

  • 8/17/2019 Manual Padrões Construção Websites

    6/7

    P'$' CSSessa #asta !ão estar os ar+ui!os de estilo do Website onde o nome do ar+ui!o ser7 onome do Website% en9um estilo de!er7 ser colocado direto no cdi$o da #7$ina osestilos de!erão ser colocados atra!.s do class ou id%

    & nomenclatura dos estilos de!er7 se$uir o #adrão nomedoebsite6@"unção6@n6% -

    nomedoebsite6 são duas letras +ue indicam o nome do Website em letras mai4sculas"unção6 . de acordo com a tabela a bai,o e n6 . um n4mero crescente começando de01%

    N#-e (' )&*+,# )&*+,#Cor ;e"ini cor de bac:$round e/ou te,to,t ;e"ine taman9o de te,to e corHn: ;e"ine taman9o e cor de lin:sI$ ;e"ine cor ou ima$em de bac:$roundit ;e"ine taman9o e cor de t*tulosIo, ;e"ine cor "ormato e ti#o de lin9as de tabela% Poder7 de"inir tamb.m

    dor de bac:$round%

    8 e o Webdesi$ner necessitar de outras nomenclaturas #ara outros estilos #oder7acrescentar sendo +ue o nome tem de estar de acordo com a "unção%

    - Webdesi$ner de!er7 declarar tamb.m todas os estilos das ta$s

    IodB ;e"inir no m*nimo bac:$round e "onte%d ;e"inir no m*nimo "onte%An#ut ;e"inir no m*nimo "onte bac:$round e lin9as%a ;e"inir no m*nimo "onte e estilo do lin:%-utros e necess7rio

    ;e!er7 tamb.m e,istir um estilo no@class +ue ser7 usado #ara de"inir a ausJncia deestilo%

    - ar+ui!o de css de!er7 sem#re estar a$ru#ado #or "unção e comentado% Km e,em#lotirado do site da E&

    /8 Estilo dos Iac:$ounds 8/%E@b$@01 L bac:$round F3F3FNO 9ei$9t 2#,O %E@b$@02 L bac:$round CQCF;EO

    /8 Estilo dos e,tos 8/%E@t,t@01 L "ont R#t &rial sans=seri"O color FFFFFFO %E@t,t@02 L "ont bold R#t &rial sans=seri"O color FFFFFFO

    P'$' TEMPLATESessa #asta ir7 conter os ar+ui!os de tem#late do #ortal o nome estar7 de acordo coma "unção do tem#late%

  • 8/17/2019 Manual Padrões Construção Websites

    7/7

    M#(e/#$

    -s modelos #ara a construção de um Website estão no ser!idor etra=AnSouse na #astacriação/modelos% -nde e,istem 2 modelos #ara a construção de Websites Websiteinde#endente e Canal%

    -s modelos de #rodutos se encontram no ser!idor etra=AnSouse na #asta inet#ub%

    Portal 2%0 /inet#ub/PortalPronto #ortal#ronto%netra%com%brPortal 3%0 /inet#ub/#ortaltec #ortaltec%netra%com%brite de T /inet#ub/T Modelo 2%0 t!modelo%netra%com%brPrJmioPublicit7rio

    /inet#ub/ba9iarecall e/inet#ub/ba9iarecall@!otacao

    ba9iarecall%netra%com%br

    D#&-e*'+,#

    -s ar+ui!os de!erão ser documentados e or$ani'ados%

    A%0&!"#$ e P'$'$;e!er7 "icar no ser!idor "inal somente ar+ui!os e #astas +ue realmente "arão #arte doWebsite todos os bac:u#s e ar+ui!os tem#or7rios de!erão ser a#a$ados%

    C;(!9#- cdi$o de!er7 "icar or$ani'ado e comentado #ara +ue a manutenção se torne "7cil%