Wiki Audience: Difference between revisions

From CCMDB Wiki
Jump to navigation Jump to search
m (Text replacement - "Wiki Usage" to "Wiki use")
 
(4 intermediate revisions by the same user not shown)
Line 1: Line 1:
This article outlines which things we still need to document on this wiki.
When writing any instructions or documentation it is important to keep in mind for whom and for what purpose.  
Please feel free to edit and add further elements.  


The intended audience for any articles on this wiki would be the kind of person likely to be hired to replace the current stakeholder. This person might know nothing about our database or even any of our hospitals, but we can expect that they bring a set of knowledge specific to their job. or example:
== Audience ==
* expect someone with basic statistics and SAS knowledge for [[:Category:Reporting|reports]] and other articles related to the [[statistician]]'s work
The intended audience for any of these would be the kind of person likely to be hired to replace the current stakeholder. For example, Julie would be able to assume someone knows SAS and statistics, and Trish would be able to assume an ICU nurse background.
* expect an ICU nurse background for a data collector
(Trish, you deleted this, but it is important. We are writing technical documentation here, and knowing who you are writing for is very important. Look it up in any technical writing information. [[User:Ttenbergen|Ttenbergen]] 22:56, 4 May 2009 (CDT))
* expect basic computing, MS Excel and MS Word knowledge for a [[data processor]]
* expect an IT background with basic VBA and batch programming for articles related [[:Category:IT Support]] and to initial analysis for articles in [[:Category: IT Instructions]]


So, an article about how to code a diagnosis that refers to "cardiac output" can assume that the person reading it will know what that is and does not first need to mention that "cardiac" means of the heart. However, any acronyms, and anything that might be specific to our environment or a particular unit, should be explained. For example, the unit name CICU at St Boniface should be explained, and any procedures that are done only there, and that an average ICU nurse might not be familiar with should be explained enough to be able to code them from the patient chart.


 
[[category: Wiki use]]
== Data collection methods ==
When how where etc, with special attention to differences between locations. This would then need to be refined down to how it '''will''' be done everywhere.
 
=== Who should do it? ===
?
 
=== Discussion===
Anything?
 
 
<!-- *************************************************************
you can copy the following for further entries:
== <topic> ==
*
 
=== Who should do it? ===
 
=== Discussion===
Anything?
 
************************************************************* -->
{{Discussion}}
*what is this page for?[[User:TOstryzniuk|TOstryzniuk]] 23:47, 10 March 2009 (CDT)
** I wrote it quite early on to give people a start as to what is needed. It has largely been replaced with the questions category, but the topics in here still have not been addressed. [[User:Ttenbergen|Ttenbergen]] 22:56, 4 May 2009 (CDT)
 
{{stub}}
[[category:Wiki Usage]]
[[Category: Questions_IT]]

Latest revision as of 12:06, 2018 September 27

When writing any instructions or documentation it is important to keep in mind for whom and for what purpose.

The intended audience for any articles on this wiki would be the kind of person likely to be hired to replace the current stakeholder. This person might know nothing about our database or even any of our hospitals, but we can expect that they bring a set of knowledge specific to their job. or example:

  • expect someone with basic statistics and SAS knowledge for reports and other articles related to the statistician's work
  • expect an ICU nurse background for a data collector
  • expect basic computing, MS Excel and MS Word knowledge for a data processor
  • expect an IT background with basic VBA and batch programming for articles related Category:IT Support and to initial analysis for articles in Category: IT Instructions

So, an article about how to code a diagnosis that refers to "cardiac output" can assume that the person reading it will know what that is and does not first need to mention that "cardiac" means of the heart. However, any acronyms, and anything that might be specific to our environment or a particular unit, should be explained. For example, the unit name CICU at St Boniface should be explained, and any procedures that are done only there, and that an average ICU nurse might not be familiar with should be explained enough to be able to code them from the patient chart.

Retrieved from "https://ccmdb.kuality.ca/index.php?title=Wiki_Audience&oldid=120253"