Documenting Our Practice

We don’t do a great job of keeping our documentation up to date. Now with me leaving and Cécile coming, it makes a lot of sense to document as much as possible of what we do, so that the transition is as smooth as possible. Though it may not be the conventional wisdom, we just don’t have the time to produce such complete documentation the rest of the time, and — more importantly — keep it up to date!

Plone never caught on as a general-purpose tool at UHS, because the graphic template was too rigid, Zope/Python were too unfamiliar to us, and the Active Directory integration was incomplete in the free version (it doesn’t support groups well enough). Plone is still perfect for internal, tech department documentation, and I still feel it is kind of like a wiki on steroids. When I finish building our new web server, I will install Plone and bind it to Active Directory, but I won’t make it available to most of our school community.

Here is my tech documentation Plone folder so far. I have a long way to go, but I am just trying to add one important topic per day as issues in that area arise.


One comment

  1. Ben Casnocha says:

    Yes, most every software company always says they will and should document along the way…and never find the "time" to do so (until an acquisition or something). Your successor will thank you for your attention to this detail.