Wiki Patterns

Patterns for successful wiki use

User Tools

Site Tools

Trace:
built-in_obsolescence

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Last revisionBoth sides next revision
built-in_obsolescence [2018/11/14 21:14] – external edit 127.0.0.1built-in_obsolescence [2018/11/18 12:20] – splitbrain
Line 1: Line 1:
-===== Built-in obsolescence ===== +====== Built-in obsolescence ======
- +
-==== What is it? ====+
  
 Many organisations are starting to use wikis for formal documentation, such as functional and technical specifications. Many organisations are starting to use wikis for formal documentation, such as functional and technical specifications.
Line 14: Line 12:
   * You cannot rely on someone to mark the documents as 'out of date' after the fact.   * You cannot rely on someone to mark the documents as 'out of date' after the fact.
  
-==== Usage ====+===== Usage =====
  
 At the creation of such a document, the creator should declare its validity period. At the creation of such a document, the creator should declare its validity period.
  
-==== Example ====+===== Example =====
  
 Some wikis, such as  [[http://www.atlassian.com|Confluence]]  allow you to create a 'template'. When creating a page, you can base the page upon a specific template. Some wikis, such as  [[http://www.atlassian.com|Confluence]]  allow you to create a 'template'. When creating a page, you can base the page upon a specific template.
Line 24: Line 22:
 This wiki pattern suggests that you create a **built-in obsolescence** template. The template would contain something like this at the top of the page: This wiki pattern suggests that you create a **built-in obsolescence** template. The template would contain something like this at the top of the page:
  
-<HTML><ul></HTML> +  * The usual stuff, like product name and feature. 
-<HTML><li></HTML>The usual stuff, like product name and feature.<HTML></li></HTML> +  * Product release number. 
-<HTML><li></HTML>Product release number.<HTML></li></HTML> +  * Document validity period e.g. June to July 2007 
-<HTML><li></HTML>Document validity period e.g. June to July 2007<HTML></li></HTML> +  * A warning message along these lines:\\ :!: **Beware of built-in obsolescence**\\ //This document was written as an aid to initial feature development. It will not be kept up to date with later enhancements. After the validity period shown above, you can use the document for a broad overview of the functionality. But do not rely on the details.// 
-<HTML><li></HTML>A warning message along these lines: +
-|{{:/images/icons/emoticons/forbidden.gif?16x16}}|**Beware of built-in obsolescence**\\ \\ <HTML><p></HTML>This document was written as an aid to initial feature development. It will not be kept up to date with later enhancements. After the validity period shown above, you can use the document for a broad overview of the functionality. But do not rely on the details.<HTML></p></HTML>| +
-<HTML></li></HTML><HTML></ul></HTML>+
  
-==== Related Patterns ====+===== Related Patterns =====
  
-  * [[Wikiphobia|Wikiphobia]] - by adding the 'built-in obsolescence' warning, we will allay the legitimate fears that incorrect information could spread throughout and even outside the organisation. +  * [[Wikiphobia]] - by adding the 'built-in obsolescence' warning, we will allay the legitimate fears that incorrect information could spread throughout and even outside the organisation. 
-  * [[WikiGnome|WikiGnome]] , also known as WikiGardener - the 'built-in obsolescence' pattern will greatly ease the WikiGnome's job, because there's no need to trawl through the wiki marking pages as out of date. +  * [[WikiGnome]] , also known as WikiGardener - the 'built-in obsolescence' pattern will greatly ease the WikiGnome's job, because there's no need to trawl through the wiki marking pages as out of date. 
-  * [[ContentAlert|ContentAlert]] - another type of content alert. +  * [[ContentAlert]] - another type of content alert. 
-  * [[Set+Window+of+Discussion|Set Window of Discussion]] - a way of forcing time sensitivity for (non-obsolescent) evolving documents+  * [[Set Window of Discussion]] - a way of forcing time sensitivity for (non-obsolescent) evolving documents
  
  
built-in_obsolescence.txt · Last modified: 2018/11/28 13:51 by splitbrain