Documente tudo.
Recentemente, houve um tópico no Slashdot sobre o início da documentação, o que me inspirou a escrever meus pensamentos sobre a documentação.
Meus pontos principais foram:
Princípio # 1: nunca é feito
A documentação é um esforço contínuo que sempre fica atrás do que está em produção. As alterações são feitas ad-hoc, as coisas mudam ou são interrompidas ou colocadas em serviço aleatoriamente. A documentação nunca será atualizada.
Você precisa vender as pessoas que pagam as contas com o valor de gastar tempo (e, portanto, dinheiro) para manter a documentação em execução atualizada. Freqüentemente, essas conversas acontecem assim: "lembra quando eu tive que gastar $ TIME descobrindo como $ THING estava quebrado? Bem, quando eu terminei, havia uma nota técnica detalhando $ THING, para que o próximo cara não tem que descobrir tudo ".
Você precisa fazer isso, mesmo que nunca termine.
Princípio # 2: A única coisa pior do que nenhuma documentação é a documentação errada
Isso é mais um truísmo do que um princípio. A documentação pode embalar você no falso senso de que algo está em um estado conhecido e que, se algo der errado, você poderá começar a corrigi-lo.
É importante reconhecer esse problema.
Princípio # 3: você está escrevendo documentação para seu sucessor
As probabilidades são 95% de tudo o que você documenta e nunca precisará se referir novamente. A documentação é uma coleção de sabedoria para o futuro, não para você. Portanto, você deve assumir que seu público sabe pouco ou nada sobre as especificidades de como as coisas são do jeito que são.
E haverá um sucessor. Não sei você, mas não pretendo ficar nesses ambientes específicos pelo resto da minha vida. As oportunidades vêm e vão, e quando elas chegam, às vezes você vai. Mas a vida continua atrás de você, e quanto mais suave você pode tornar a vida de seu sucessor, melhor. Caso contrário, você pode ter uma coleção de ex-clientes que dizem silenciosamente coisas pouco lisonjeiras sobre você. Eu gosto de dizer que são os mesmos 50 funcionários trabalhando em todos os lugares da TI em Ottawa porque você os encontra em todos os lugares. Ajudar seu sucessor pode abrir portas para você no futuro.
Agora, até certo ponto, sempre há um grau de "culpar o sujeito anterior" quando surgem problemas. Isso faz parte do negócio. Eu já fiz isso sozinho. Mas em várias ocasiões em que eu considerava o cara anterior um tipo de idiota, aprendi de outra maneira que ele realmente agia em conjunto e sabia mais sobre o que estava acontecendo do que eu na época.
Princípio # 4: "Por que" geralmente é mais importante que "Como"
Quando olhamos para um sistema, a maioria de nós começa a pensar assim: por que diabos é isso? Quase sempre existem razões muito específicas para as escolhas de configuração feitas. Nessas circunstâncias, o "Por que" determina o "Como", e você deve certificar-se de que o leitor entenda os problemas específicos que estão sendo resolvidos ao examinar os restos de fumar da sua solução.
Princípio # 5: Tem que ser fácil ou você não o fará
Isso significa que você precisa estar muito ciente de suas ferramentas, bem como daqueles que irão usá-las.
Manter as coisas atualizadas deve ser fácil. Se você precisar fazer algum tipo de esforço, encontrará desculpas para evitar fazê-lo quando for melhor, o que ocorre imediatamente após uma alteração.
Se suas ferramentas não forem fáceis de serem usadas por outras pessoas, elas não serão usadas. Isso pode ser especialmente prejudicial em um ambiente de equipe, pois quanto maior a equipe, maior a probabilidade de você encontrar um membro da equipe que não gosta da sua escolha de ferramentas.
Pessoalmente, gosto de um wiki para documentos. No entanto, o problema é que um wiki não impõe uma estrutura a você, portanto a estrutura deve ser imposta de fora. Isso sempre leva a conflitos em algum lugar, pois outra pessoa tem uma idéia melhor / diferente.
Em alguns lugares, usei documentos do Word e Visio "publicados" em PDF, com o PDF "mais recente" sendo considerado autoritativo. Isso é bom, pois você tem uma coleção que pode entregar ao seu empregador / sucessor. Os PDFs, se devidamente datados, podem fornecer um registro histórico do que aconteceu, embora não seja fácil navegar. É ruim o fato de eu não gostar do Word ou do Visio e ter sido forçado a obter um entendimento básico dessas ferramentas para comunicar efetivamente as idéias.
Meu empregador atual está brincando com a idéia de documentos do Word em um portal do Sharepoint. Nós apenas teremos que ver até onde chegamos lá