Ranter
Join devRant
Do all the things like
++ or -- rants, post your own rants, comment on others' rants and build your customized dev avatar
Sign Up
Pipeless API
From the creators of devRant, Pipeless lets you power real-time personalized recommendations and activity feeds using a simple API
Learn More
Comments
-
ViRaS19676yMaybe you should do it just to deem your project complete and for personal satisfaction.
-
@ViRaS you do have a valid point about that. Probably better to leave at least something rather than nothing.
-
Pickman6526yDo it in the best way possible. When you find good documentation written from someone who is not there anymore it's the best thing ever.
-
matste6416yYou are absolutely correct. No one will read it.
They will rediscover all the solutions, you write down. They will ask stupid questions even the first one from your FAQ. They will complain there’s no documentation, even if it’s on the main project page. Their imaginary vision of the system will always dominate the actually implemented version.
This is just human nature.
Luckily, you will be gone, so you will be spared the frustration of dealing with people.
Related Rants
So I handed in my official resignation last week as I will be changing to a new job next month. So one of the last big things that I have been working on is a Jenkins server for the rest of the team to use and currently writing up the documentation for it.
However I haven't been told who I will be handing over my work to, but the bigger thing I feel is that even if I write all the documentation, no one will actually read it. Reason I think this is because I doubt anyone else in the team will even use the Jenkins server. The major issues are that no one writes unit tests and don't even understand what CI is!
So right now it feels like my final month of work will all be for nothing and makes me wonder if I should even bother writing documentation, especially if it isn't going to be handed over to anyone.
rant
handover
documentation