{"id":4,"date":"2007-10-10T15:29:19","date_gmt":"2007-10-10T22:29:19","guid":{"rendered":"http:\/\/www.imaginarybillboards.com\/?p=4"},"modified":"2010-01-27T19:14:47","modified_gmt":"2010-01-28T02:14:47","slug":"documentation-should-be-in-a-wiki","status":"publish","type":"post","link":"http:\/\/www.imaginarybillboards.com\/?p=4","title":{"rendered":"Documentation should be in a wiki"},"content":{"rendered":"

Let me repeat that. \u00c2\u00a0Documentation should be in a wiki.<\/p>\n

Here is how things are done in my corporate world. \u00c2\u00a0For keeping track of versions, other info, etc we have a series of Excel files kept either on a shared network drive or in The Worst Software Ever (Lotus Notes). \u00c2\u00a0Which either means<\/p>\n

A)<\/p>\n

1-\u00c2\u00a0Finding\u00c2\u00a0the\u00c2\u00a0excel\u00c2\u00a0file\u00c2\u00a0link\u00c2\u00a0or\u00c2\u00a0browsing\u00c2\u00a0the\u00c2\u00a0shared\u00c2\u00a0folders\u00c2\u00a0looking\u00c2\u00a0for\u00c2\u00a0it<\/p>\n

2-\u00c2\u00a0Opening\u00c2\u00a0it\u00c2\u00a0and\u00c2\u00a0hoping\u00c2\u00a0it’s\u00c2\u00a0not\u00c2\u00a0in\u00c2\u00a0use\u00c2\u00a0(and\u00c2\u00a0thus\u00c2\u00a0locked)<\/p>\n

2a- If locked, try to remember to make the change later (and forget)<\/p>\n

3-\u00c2\u00a0Editing\u00c2\u00a0the\u00c2\u00a0file,\u00c2\u00a0trying\u00c2\u00a0to\u00c2\u00a0find\u00c2\u00a0the\u00c2\u00a0\u00c2\u00a0appropriate area and fill in a lot of non-friendly fields<\/p>\n

or<\/p>\n

B)<\/p>\n

1-\u00c2\u00a0Opening\u00c2\u00a0TWSE\u00c2\u00a0and\u00c2\u00a0waiting\u00c2\u00a0for\u00c2\u00a0it\u00c2\u00a0to\u00c2\u00a0open.<\/p>\n

2-\u00c2\u00a0Trying\u00c2\u00a0to\u00c2\u00a0find\u00c2\u00a0the\u00c2\u00a0link\u00c2\u00a0you\u00c2\u00a0saved\u00c2\u00a0to\u00c2\u00a0where\u00c2\u00a0the\u00c2\u00a0file\u00c2\u00a0is\u00c2\u00a0because\u00c2\u00a0you\u00c2\u00a0can’t\u00c2\u00a0search\u00c2\u00a0in\u00c2\u00a0TWSE<\/p>\n

3-\u00c2\u00a0Opening\u00c2\u00a0a\u00c2\u00a0file\u00c2\u00a0which\u00c2\u00a0involves\u00c2\u00a0multiple\u00c2\u00a0clicks,\u00c2\u00a0editing\u00c2\u00a0steps,\u00c2\u00a0etc<\/p>\n

4-\u00c2\u00a0Repeating\u00c2\u00a0the\u00c2\u00a0steps\u00c2\u00a0from\u00c2\u00a0above\u00c2\u00a0with\u00c2\u00a0the\u00c2\u00a0actual\u00c2\u00a0file.<\/p>\n

Compare\u00c2\u00a0this\u00c2\u00a0with\u00c2\u00a0a\u00c2\u00a0wiki.<\/p>\n

1-\u00c2\u00a0Open\u00c2\u00a0the\u00c2\u00a0wiki<\/p>\n

2-\u00c2\u00a0Search\u00c2\u00a0for\u00c2\u00a0your\u00c2\u00a0thing\u00c2\u00a0you\u00c2\u00a0are\u00c2\u00a0documenting (or going to the bookmark even)<\/p>\n

3-\u00c2\u00a0Clicking\u00c2\u00a0“Edit”.<\/p>\n

4-\u00c2\u00a0Changing\u00c2\u00a0the\u00c2\u00a0page\u00c2\u00a0which\u00c2\u00a0can\u00c2\u00a0be\u00c2\u00a0any\u00c2\u00a0format\u00c2\u00a0that\u00c2\u00a0makes\u00c2\u00a0sense.<\/p>\n

Note also that with some customization of open source wiki software, you could also either automagically populate a main status page from the wiki or from the thing you’re documenting directly. \u00c2\u00a0This could also be done for versions, etc. \u00c2\u00a0Summation then: \u00c2\u00a0automatic populating of things is of course best, but short of that whatever you’re working on should be A) searchable, and B) very easily editable.<\/p>\n","protected":false},"excerpt":{"rendered":"

Let me repeat that. \u00c2\u00a0Documentation should be in a wiki. Here is how things are done in my corporate world. \u00c2\u00a0For keeping track of versions, other info, etc we have a series of Excel files kept either on a shared network drive or in The Worst Software Ever (Lotus Notes). \u00c2\u00a0Which either means A) 1-\u00c2\u00a0Finding\u00c2\u00a0the\u00c2\u00a0excel\u00c2\u00a0file\u00c2\u00a0link\u00c2\u00a0or\u00c2\u00a0browsing\u00c2\u00a0the\u00c2\u00a0shared\u00c2\u00a0folders\u00c2\u00a0looking\u00c2\u00a0for\u00c2\u00a0it […]<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":[],"categories":[15],"tags":[7,33,5],"_links":{"self":[{"href":"http:\/\/www.imaginarybillboards.com\/index.php?rest_route=\/wp\/v2\/posts\/4"}],"collection":[{"href":"http:\/\/www.imaginarybillboards.com\/index.php?rest_route=\/wp\/v2\/posts"}],"about":[{"href":"http:\/\/www.imaginarybillboards.com\/index.php?rest_route=\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"http:\/\/www.imaginarybillboards.com\/index.php?rest_route=\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"http:\/\/www.imaginarybillboards.com\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=4"}],"version-history":[{"count":1,"href":"http:\/\/www.imaginarybillboards.com\/index.php?rest_route=\/wp\/v2\/posts\/4\/revisions"}],"predecessor-version":[{"id":94,"href":"http:\/\/www.imaginarybillboards.com\/index.php?rest_route=\/wp\/v2\/posts\/4\/revisions\/94"}],"wp:attachment":[{"href":"http:\/\/www.imaginarybillboards.com\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=4"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"http:\/\/www.imaginarybillboards.com\/index.php?rest_route=%2Fwp%2Fv2%2Fcategories&post=4"},{"taxonomy":"post_tag","embeddable":true,"href":"http:\/\/www.imaginarybillboards.com\/index.php?rest_route=%2Fwp%2Fv2%2Ftags&post=4"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}