Re: RES: [GTER] "Faça um manual para que qualquer um p ossa resolver o problema."

[Rubens Kuhl Jr.]

Marlon,

Você não pode deixar o erro da empresa/chefes de achar que
receita-de-bolo resolve problemas não-lineares como os de TI, fazer
você cometer o erro de não documentar.

Minha sugestão, muito próxima de outra dada nesta thread, é gerar dois
documentos:
1) Um descritivo do projeto focado em conhece os produtos usados, e
contém apenas os detalhes relevantes de customização. Então se foi
usado um Debian Linux, por exemplo, apareceria como "Instalado Debian
Linux Sarge 3.1".
2) Um as-built do projeto com todos os passos dados (no exempo do ítem
anterior, apareceriam telas de seleção de pacotes e histórico de
comandos). Log no programa terminal usado para configurar uma máquina
*nix ou equipamento de rede é ótimo para gerar isso quase
automagicamente.

Isso consegue contemplar todos os públicos: aos realmente aptos, o
descritivo não entra em detalhes desnecessários, e o as-built permite
reconhecer alguma especificidade que tenha escapado do primeiro ítem
quando de um troubleshooting mais complicado. Aos PHBs
(PHB=Pointed-Hair-Boss, chefe do Dilbert), o as-built tem toda a
aparência de que a Dona Marta (a secretária tarada do Angeli)
conseguiria fazer a instalação, porém não há nada no documento que
diga isso, o que atende à sua vontade de não assinar embaixo de algo
que você sabe que não vai funcionar (deixar alguém não qualificado
instalar o sistema).


Rubens



On 2/21/06, MARLON BORBA <MBORBA at trf3.gov.br> wrote:
> Até certo ponto concordo. Não ataco o dever de documentar. O problema está na empresa e/ou no chefe pães-duros que utilizem os manuais como uma forma cômoda de se esquivarem da obrigação de investir em treinamento do pessoal.
>
> Há ainda o problema das pessoas que desejam ver tudo resolvido com o mínimo esforço (desobrigando-se, por exemplo, de melhorar a própria formação). Eu, pelo menos, se tenho de seguir a receita de bolo, preciso entender muito bem por que estou executando os passos (se existir uma instrução do tipo "beba estricnina" e eu a seguir sem nenhum senso crítico terei carimbado o passaporte para Caixa-Pregos).
>
>
>
>
>
> Abraços,
> Marlon Borba, CISSP.
> --
> Se você acha que a criptografia pode resolver
> todos os seus problemas de segurança,
> então você não conhece os seus problemas
> e nem a criptografia.
> (Bruce Schneier)
> --
>
> >>> eduardo at sinos.net 21/2/2006 13:50:45 >>>
> Marlon, por mais complexas que sejam as atuais tarefas, configurações,
> testes ou sistemas, sempre são necessários os manuais. [...]
>
> --
> gter list    https://eng.registro.br/mailman/listinfo/gter
>