Quão útil é um log ou diário de projeto? [fechadas]

Quero saber o quão difícil / útil é manter um diário ou registro do projeto. Estou preocupado que acompanhar o que fiz consuma muito tempo ...

Estou preocupado que acompanhar o que fiz consuma muito tempo ...

Eu me preocupo com o oposto. Muitas vezes acho que o custo de não documentar algo consome ainda mais do meu tempo. Talvez isso não aconteça hoje. Talvez não amanhã, mas em algum momento a maioria das coisas que eu fiz surgiram novamente em algum momento, e isso geralmente acontece depois de um tempo suficiente para que meu cérebro considere isso sem importância.

Assim, eu documento as coisas. Documento as decisões que tomei, acordos feitos com os membros da equipe e, o mais importante, documento meu código, mesmo que apenas envolva o uso de palavras-chave para facilitar o cumprimento do projeto por uma determinada função ou linha de código.

Em alguns casos, a documentação também economizou o tempo de outras pessoas. É nesses casos que os X minutos gastos em documentação se tornaram um investimento em si, enquanto os X minutos investidos deram um retorno Y * X minutos em economia de tempo!

Por fim, em outros casos, descobri que o trabalho de documentação me ajuda a lembrá-lo. Em alguns casos, nunca mais examinei a documentação porque, para mim, escrever algo é um catalisador para gravá-la em minha memória.

Todo mundo é diferente, e você precisará descobrir o que funciona para você. Quanto a mim, não posso dizer que me arrependi do tempo gasto documentando meu trabalho, mas com certeza me arrependi dos tempos que não.

Embora essa seja uma pergunta bastante geral, acho que a resposta se resume a quão valioso você vê a auto-reflexão.

Se a capacidade de rever o progresso é mais valiosa para você do que trabalhar o tempo que você levasse para fazer anotações sobre o progresso, eu diria que é uma atividade que vale a pena.

Eu acho que, como programador trabalhando em um software, é bom ter algum log de progresso e etapas (semelhantes às notas de controle de versão) para acompanhar as alterações que você fez, onde as fez e por quê. Informações muito úteis ao solucionar problemas e ao lidar com profissionais similares

Dito isto, não é difícil. É apenas mais útil se você puder fazê-lo regularmente, e isso é auxiliado por entrar em uma rotina para a maioria das pessoas.

Experimente por 3 meses. Escolha um formato simples com o qual você possa se comprometer e faça. Se oferecer benefícios, mantenha-o, caso contrário, deixe-o cair. Toda semana, revise o formato de suas entradas e ajuste-as, se necessário.

Tente o seguinte:

No início de cada dia, anote

• O que você fará (parágrafo, planilha, qualquer forma que você quiser)
• Que problemas você espera encontrar

No final de cada dia, anote

• O que você fez
• Quais obstáculos surgiram no seu caminho
• Quais são as três coisas que você aprendeu (técnico, não técnico, etc)

A cada semana, analise

Provavelmente leva 5 minutos no início e no final de cada dia. Mais tarde, você pode adicionar coisas que você se pergunta toda semana ou coisas que lhe interessam. Não tenha medo de mudar de formato ... papel uma semana, Wiki na próxima, Trello um terceiro. Vai demorar um mês ou mais para se adaptar a um estilo e encontrar um ritmo.

É tempo bem gasto. Eu mantenho todas as minhas anotações em um programa chamado Texto Conectado . Refiro-me a problemas, reuniões, itens do CYA, notas de programação, notas de idioma, trechos de API, etc. Também uso o Evernote para recortar coisas da Web e depois transformá-las em anotações. Muito do que você fará em sua carreira voltará a aparecer, portanto, é recomendável ter anotações sobre como você resolveu esses problemas. Eu vejo isso como carregando as minúcias para manter em mente as coisas importantes, sabendo que posso me referir novamente às minhas anotações. Afinal, é por isso que você faz anotações para começar.

Não é uma perda de tempo.

Eu uso um wiki pessoal há cerca de 7 anos, Wiki on a Stick ou WoaS: http://stickwiki.sourceforge.net/

Criei uma base de conhecimento para todos os softwares que apoio, links para vários recursos técnicos, anotações para reuniões de equipe - todos eles são conferências telefônicas, ambiente de desenvolvimento de documentos e objetivos técnicos e profissionais, listas de tarefas, etc. em um bloco de notas ou pegajoso vai neste wiki. Usando o Firefox em http://portableapps.com , todo o meu wiki é independente, não requer um servidor ou instalação de nenhum software no computador-cliente. Também funciona em várias plataformas. O único problema que tive foi usando o Chrome. Não salvará nenhuma alteração. O Firefox funcionou melhor, então eu continuo com ele.

Houve várias vezes em que um projeto foi queimado apenas para ressuscitar 9 meses depois. O WoaS me trouxe de volta de onde eu parei e foi produtivo sem tentar lembrar o que havia feito anteriormente ou o que aconteceu com o bloco de notas que eu estava usando naquela época.

Nunca me arrependi de ter tempo para documentar meu trabalho. Depois de alguma prática, não é preciso muito tempo para fazer anotações. Se você pode desenvolver um processo simples, mas afetivo, é mais provável que o faça.

É uma peça de literatura.

Como nos tempos antigos, o conhecimento era melhor preservado quando escrito. A "tradição oral" não é tão eficaz.

É um sinal de maturidade quando se faz isso. Para responder sua pergunta: é muito útil. Você nunca vai ler seu trabalho no futuro. É uma boa contribuição.

No topo da minha cabeça, aqui estão apenas algumas razões pelas quais é importante manter um registro.

• Se você deseja patentear algo que você inventou, um livro de registro se torna uma evidência muito importante.
• Se você trabalha em um ambiente em que há uma cultura de culpa, anote o que fez, quando, o que foi dito, etc., simplesmente para cobrir suas próprias costas.
• Se você deseja acompanhar os pensamentos ou idéias que você não tem tempo para explorar imediatamente, um diário de bordo é um bom lugar para anotar as coisas para revisão posterior.
• Se você trabalha em vários projetos e o seu quadro de horários exige uma contabilidade relativamente detalhada do seu trabalho para rastrear os custos do projeto ou cobrar dos clientes, o livro de registro se torna um local para rastrear seu tempo.
• Notas da reunião da equipe, agendas e assim por diante.
• Acordos, desacordos, decisões e, especialmente, por que e como essas coisas ocorreram podem salvar a vida real quando as informações são realmente necessárias.

Sempre que eu terminar de escrever na última página de um livro de registro, me vejo olhando livros antigos de anos antes, apenas para ver até que ponto meu conhecimento chegou, como meu pensamento mudou e pode ser incrível o que você aprenda com seu próprio passado profissional, principalmente se estiver pensando em mudar de emprego e desejar preencher seu currículo com muitos projetos e realizações realmente interessantes.

Depende muito do tamanho e dos objetivos do projeto. Em um projeto pequeno, você pode colocar as coisas no Excel. Lembre-se de que o retrabalho leva mais tempo do que fazer algo certo da primeira vez; portanto, vale a pena planejar um pouco para economizar tempo mais tarde.

Coisas que você deve acompanhar nas listas:

• Compromissos externos, especialmente datas.

• Escopo - pelo menos em um nível alto. Dependendo da situação, isso fica mais detalhado.

• Dependências - o que você precisa dos outros.

• Questões, riscos e tarefas

• Em que tempo você gasta (o rigor depende se isso é para autoconhecimento ou cobrança externa)