Legacy Content: Difference between revisions

(5 intermediate revisions by the same user not shown)

Line 1:

This page is about legacy documentation on the wiki.

~~There are pages that exclusively contain legacy content~~, ~~ie information that may be required to interpret old~~ data ~~or former processes but that is no longer valid. We have~~ [[~~:Template:LegacyContent~~]] ~~to manually annotate legacy pages~~. ~~Other pages such as ICD10 dxs will automatically declare themselves as legacy once their stop date has passed. This allows us to automatically generate the following list of legacy pages:~~

== Background ==

This wiki has different audiences: the [[Data collector]]s for collection instructions, [[Main office]] for overall documentation of processes around running our program, the [[Data processor]] for how she does quality control, and the [[Statistician]] for interpreting our data and [[Reporting]] from it.

When things change, the documentation on the wiki may become no longer relevant to some groups (e.g. collectors), but it may still be important to others (e.g. the statistician for interpreting old data).

We needed a way to retain this info without risking that a reader in a hurry will think instructions are for current processes.

== How we treat legacy information ==

'''If you delete a page or declare all of it legacy, you need to clean up links to it.''' Often other pages on the wiki refer to instructions on a page. If it becomes legacy, often (but not always) those links should be removed. If this step is omitted other parts of the wiki may refer to the legacy bits as if they were active parts of our processes.

To do this, click the "what links here" link under tools in the left bar.

This may seem like a nuisance step, but it is actually an automated checklist to keep things consistent. It's also an important reason to actually link to things when you refer to them, so they will be caught by this cleanup process.

=== If the content is relevant for data we retain ===

If the content is relevant for data we retain, use [[:Template:LegacyContent]] to place the content behind an expand button. This way it is visible for the [[Statistician]] and other users of the data when needed, but is less likely to confuse a collector who is scanning pages in a hurry.

Initially the template was meant for full pages but it turned out that often it's part of a page that becomes legacy. If so, make a "Legacy" heading at the bottom of the page, add the template there, and move the legacy content there with a bit of context, and a subheading if it gets big.

=== Exception - Delete it with reference to page history ===

There have been a few occasions where legacy content "pollutes" search results to the point where the current information is hard to find. In those cases, delete the ''content'' of the page, but leave the page. Write something on the page that refers the reader to the page history.

Example: [[Lab Collection Process]]

=== Delete it without reference to history ===

In rarer circumstances old instructions are no longer relevant at all. Example: [https://ccmdb.kuality.ca/index.php?title=Oaks_ICU_Collection_Guide&action=edit&redlink=1 Oaks ICU Collection Guide ] - it didn't contain anything we need to know to interpret data in the future, so deleted. If it had included information about how we need to interpret Oaks data in the future we would have kept the page and just declared it legacy.

=== Special Cases ===

Some templates include designation as legacy content based on stop / end dates. ICD10 Dx pages and old diagnosis pages are examples of these.

== List of pages with legacy content ==

This is a list of pages with legacy content based on their use of [[:Template:LegacyContent]]:

{{#ask: [[Category:Legacy Content]] [[!:Legacy Content]]

|?HasLegacyExplanation

Line 11:

Line 38:

|class=sortable wikitable smwtable

}}

== Related articles ==

[[Category:Legacy Content| *]]

[[Category:Wiki ~~Usage~~]]

[[Category:Wiki use]]

@@ Line 1: / Line 1: @@
 This page is about legacy documentation on the wiki.
-There are pages that exclusively contain legacy content, ie information that may be required to interpret old data or former processes but that is no longer valid. We have [[:Template:LegacyContent]] to manually annotate legacy pages. Other pages such as ICD10 dxs will automatically declare themselves as legacy once their stop date has passed. This allows us to automatically generate the following list of legacy pages:
+== Background ==
+This wiki has different audiences: the [[Data collector]]s for collection instructions, [[Main office]] for overall documentation of processes around running our program, the [[Data processor]] for how she does quality control, and the [[Statistician]] for interpreting our data and [[Reporting]] from it.
+When things change, the documentation on the wiki may become no longer relevant to some groups (e.g. collectors), but it may still be important to others (e.g. the statistician for interpreting old data).
+We needed a way to retain this info without risking that a reader in a hurry will think instructions are for current processes.
+== How we treat legacy information ==
+'''If you delete a page or declare all of it legacy, you need to clean up links to it.''' Often other pages on the wiki refer to instructions on a page. If it becomes legacy, often (but not always) those links should be removed. If this step is omitted other parts of the wiki may refer to the legacy bits as if they were active parts of our processes.
+To do this, click the "what links here" link under tools in the left bar.
+This may seem like a nuisance step, but it is actually an automated checklist to keep things consistent. It's also an important reason to actually link to things when you refer to them, so they will be caught by this cleanup process.
+=== If the content is relevant for data we retain ===
+If the content is relevant for data we retain, use [[:Template:LegacyContent]] to place the content behind an expand button. This way it is visible for the [[Statistician]] and other users of the data when needed, but is less likely to confuse a collector who is scanning pages in a hurry.
+Initially the template was meant for full pages but it turned out that often it's part of a page that becomes legacy. If so, make a "Legacy" heading at the bottom of the page, add the template there, and move the legacy content there with a bit of context, and a subheading if it gets big.
+=== Exception - Delete it with reference to page history ===
+There have been a few occasions where legacy content "pollutes" search results to the point where the current information is hard to find. In those cases, delete the ''content'' of the page, but leave the page. Write something on the page that refers the reader to the page history.
+Example: [[Lab Collection Process]]
+=== Delete it without reference to history ===
+In rarer circumstances old instructions are no longer relevant at all. Example: [https://ccmdb.kuality.ca/index.php?title=Oaks_ICU_Collection_Guide&action=edit&redlink=1 Oaks ICU Collection Guide <!-- done as external link so redlink for missing page is not flagged-->] - it didn't contain anything we need to know to interpret data in the future, so deleted. If it had included information about how we need to interpret Oaks data in the future we would have kept the page and just declared it legacy.
+=== Special Cases ===
+Some templates include designation as legacy content based on stop / end dates. ICD10 Dx pages and old diagnosis pages are examples of these.
+== List of pages with legacy content ==
+This is a list of pages with legacy content based on their use of [[:Template:LegacyContent]]:
 {{#ask: [[Category:Legacy Content]] [[!:Legacy Content]]
   |?HasLegacyExplanation
@@ Line 11: / Line 38: @@
   |class=sortable wikitable smwtable
 }}
+== Related articles ==
+{{Related Articles}}
 [[Category:Legacy Content| *]]
-[[Category:Wiki Usage]]
+[[Category:Wiki use]]