Ok, it has been more than a week now, I have still not seen any Perl code related to the stuff I am supposed to work on.
My first task/project will be to document the existing code base etc.
So I instead of working I have written a document or how I intend to work, crazy.
I am planning to map all the modules/classes, which I need to visit. I will then use a iterary (can you say that?) process of reading code, writing POD, adding tests and doing some simple code reviews and also using Perl::Critic. I will document the results of the test implementation, code review and analysis as TODO lists for possible later refactoring, since the code is in production and it would be a bad idea just to start hacking away - and this is not the goal of the project I am attempting to set up.
Apart from the POD I also plan to write a more general and traditional document on the system using a word processor. This document will be intended for a different audience and will include visuals etc. where the POD aim at developers.
Maintenance documentation already exist and I only expect to brush up on this to glue it together with the POD and the general documentation.
I plan to add a FAQ to accumulate all my stupid questions and as they get answered the will hopefully reference to sections in the documentation that I will be writing.
If they buy it (my proposal) I plan to sell the project to another department aswell. I do not know why, but I actually enjoy writing documentation, especially if you can define how to do it yourself.
So we are not close to getting going, so I think I will do some other stuff tomorrow instead of wasting time waiting for a firewall opening, a CVS account and a contract.
Re:iterary
jonasbn on 2007-05-22T05:01:09
of course:)
thanks
