Hacker Newsnew | past | comments | ask | show | jobs | submitlogin

In between commit messages, bugs and design docs, I'm not sure what I'd put in a log book.


I think maybe documenting architectural decisions might make sense: http://thinkrelevance.com/blog/2011/11/15/documenting-archit...


- The logic/design of parts of the code base which you might newly encounter

- What work was done for the day, yes you might use something like Jira but a journal can be also good at the same time

- New things you learn.

etc etc etc


Each to their own of course but it seems to me, there's better places for all of that. If there's logic or design that's complicated and not properly commented or documented, then that's worth doing and sharing with the team.

Work done for the day for me is typically captured in commits or bug updates - that way my colleagues can easily take over if I win the lottery or are suddenly taken ill.

And stuff I learn is learned, so I don't need to write that down :-)

Working in a team, shared information is critical and logbooks just aren't the best way to achieve that.


> If there's logic or design that's complicated and not properly commented or documented, then that's worth doing and sharing with the team

It's the meta also, it is capturing the models mentally and ideas and notes. This reduces cognitive load, and actually by making notes increases the chances of you remember something.

> And stuff I learn is learned, so I don't need to write that down :-)

Hey if thats the case then fine, but generally memory deteriorates, recall becomes more difficult and the details change.

> Working in a team, shared information is critical and logbooks just aren't the best way to achieve that.

Log books are not generally for the team, they are for you.

But as you say each to their own.


This does not have to be "either-or". As we see an increased focus on teamwork this could evolve into a shared (electronic) team logbook.




Guidelines | FAQ | Lists | API | Security | Legal | Apply to YC | Contact

Search: