{"id":540,"date":"2013-08-13T03:41:41","date_gmt":"2013-08-13T08:41:41","guid":{"rendered":"http:\/\/www.smbitjournal.com\/?p=540"},"modified":"2017-02-18T14:33:10","modified_gmt":"2017-02-18T19:33:10","slug":"doing-it-at-home-good-documentation","status":"publish","type":"post","link":"https:\/\/smbitjournal.com\/2013\/08\/doing-it-at-home-good-documentation\/","title":{"rendered":"Doing IT at Home: Good Documentation"},"content":{"rendered":"

One of the most rewarding home IT projects that I have done was to implement a system for “home documentation.”\u00a0 In a business environment documentation is critical to nearly any process or department.\u00a0 At home, documentation is critical too but often overlooked or approached from a completely different perspective than it is in a business, but there is no need for this.\u00a0 Many people resort to special tools, iPhone apps or physical pen & paper notepads to address documenting things around the house.\u00a0 I propose something far more enterprise and elegant.\u00a0 A wiki.<\/p>\n

Wikis have been around for some time now and nearly everyone is familiar with their use.\u00a0 At its core a wiki is just a web-based application.\u00a0 Wikis come in many shapes and forms and with varying degrees of complexity and run on different platforms.\u00a0 This makes them very flexible and applicable to nearly anyone, regardless of what kind of systems you run at home.<\/p>\n

Using a wiki for home use becomes very obvious quite quickly once the project is underway.\u00a0 Documenting bills, accounts, purchases, home repairs, part numbers, service schedules, insurance information and your home network, of course, all make perfect sense and are easy to do.\u00a0 The wiki does not need to be large, just big enough to be useful.\u00a0 Mine is certainly not sprawling but all of my important data is housed in one, convenient place and is text searchable.\u00a0 So even if I don’t know how I organized something, I can just search on it.\u00a0 All of my important data is there, in a single place, so that I can look it up when needed and, more importantly, my wife can look it up and update it when needed.\u00a0 It allows for simple, reliable collaboration.\u00a0 And I make mine available from inside or outside the home, so I can access my information from work or while traveling.\u00a0 That’s a functionality that traditional home documentation systems lack.<\/p>\n

While there are many wikis available today, I will mention three that make the most sense for the vast majority of people.\u00a0 These are DokuWiki, MediaWiki and SharePoint from Microsoft.\u00a0 DokuWiki and MediaWiki have the advantage of running on UNIX so can be deployed in a variety of situations for low or no cost.\u00a0 They are free themselves. DokuWiki shines in that it needs no database and uses nothing but the filesystem making it incredible simple to deploy, manage, backup and restore.\u00a0 It is nothing more than a set of text files and a small PHP application that writes them.\u00a0 MediaWiki is, by far, the most popular wiki option and, like DokuWiki, is an PHP application but is backed by a database, normally MySQL, making it more complex but giving it more power as well.\u00a0 Many people would choose MediaWiki to use for home (as do I) because it provides the most direct experience for the largest number of businesses.\u00a0 SharePoint is free if you have a Windows Server and is much more complex than the pure wiki options.\u00a0 SharePoint is an entire application platform that also includes a wiki as a part of its core functionality.\u00a0 If you are looking to move more heavily into the Microsoft ecosystem then using SharePoint would likely make the most sense and will provide a lot of additional functionality like calendaring and document storage too.<\/p>\n

Running a wiki can help give meaning to a home web server.\u00a0 Instead of sitting idle it can house important applications and really be used regularly.\u00a0 While not a massive project having a wiki at home could be an important step to giving meaning to the home IT environment.\u00a0 IT at home often suffers from lacking direction or purpose – implementing systems only like a lab and lacking real world use.\u00a0 Like the PBX example in an earlier article, a home documentation wiki can give your network meaning and purpose.<\/p>\n","protected":false},"excerpt":{"rendered":"

One of the most rewarding home IT projects that I have done was to implement a system for “home documentation.”\u00a0 In a business environment documentation is critical to nearly any process or department.\u00a0 At home, documentation is critical too but often overlooked or approached from a completely different perspective than it is in a business, … Continue reading Doing IT at Home: Good Documentation<\/span> →<\/span><\/a><\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[85,166,86],"tags":[28,23],"_links":{"self":[{"href":"https:\/\/smbitjournal.com\/wp-json\/wp\/v2\/posts\/540"}],"collection":[{"href":"https:\/\/smbitjournal.com\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/smbitjournal.com\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/smbitjournal.com\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/smbitjournal.com\/wp-json\/wp\/v2\/comments?post=540"}],"version-history":[{"count":1,"href":"https:\/\/smbitjournal.com\/wp-json\/wp\/v2\/posts\/540\/revisions"}],"predecessor-version":[{"id":541,"href":"https:\/\/smbitjournal.com\/wp-json\/wp\/v2\/posts\/540\/revisions\/541"}],"wp:attachment":[{"href":"https:\/\/smbitjournal.com\/wp-json\/wp\/v2\/media?parent=540"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/smbitjournal.com\/wp-json\/wp\/v2\/categories?post=540"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/smbitjournal.com\/wp-json\/wp\/v2\/tags?post=540"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}