Discussion: "The Server IS the Documentation" (OR Standard Process [Obnosis] verses Useless Arrogance [Experience/Training])

[JD Austin]

On Thu, May 16, 2013 at 9:03 PM, Lisa Kachold <lisakachold at obnosis.com>wrote:

> The Server IS the documentation"


I can't picture myself every using that phrase.  When it's all volunteer I
get that it's not a primary focus to do documentation for things. I've
lurked too much to know what egos might be at play but the server is not
the documentation :)

A server without documentation on how/why it was built is a server nobody
else can re-implement and one you have to figure out from scratch all over
again.  It is creating a bus factor.... it's lazy and foolish not to make
as detailed documentation as you can for production servers.  You end up
with servers that you can't upgrade easily because you're not sure what is
stock and what is modified in a lot of cases.   I regret every time I rush
through something and don't take the time to screen shot each step and make
documentation I can refer to later.   I make mind maps while planning and
make detailed step by step plans (often in html) that anyone with requisite
knowledge can follow because even I don't remember all the little details 2
years later.  I don't however do so when I'm working for a client that
won't pay for the time to do so.

I've worked with people that think siloing knowledge is job security but
their projects are a nightmare to deal with when it's time to do major
upgrades and in a lot of cases it snowballs because of the delays it
causes.  I think siloing knowledge is selfish and pointless since even if
you document every little detail and give it to the client almost 100% of
the time they still want you to do it.

I hope people don't get too bent out of shape by such open communication;
it's healthy for the most part and things fester and gets worse otherwise.
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.phxlinux.org/pipermail/plug-discuss/attachments/20130516/68e1bdad/attachment.html>