Middlebury

Difference between revisions of "Wiki Editing Protocol"

(Updating page content and purpose to reflect presence of HI)
(Reworking)
Line 1: Line 1:
[[Category:Helpdesk]]
 
 
Information on the purpose of this wiki, what to put in it, how to organize it, how to edit it.
 
Information on the purpose of this wiki, what to put in it, how to organize it, how to edit it.
  
 
==Purpose & Content==
 
==Purpose & Content==
We can use a wiki to improve our organization and communication in many ways.
+
This wiki is used for:
# A place to keep track of common computer problems and how to approach them.
+
# Document computer problems and keep up-to-date information on information on specific computer topics.
# A place to organize our growing collection of how-to articles, to make them more accessible to the public than our current knowledgebase system does.
+
# How-tos for internal (and some external) reference in solving problems.
# A place to codify the Helpdesk policy re: language schools, licensing, and the help we offer.
+
# Clarifying our policies on what services we do and don't provide.
# A place to post news on changes to the Helpdesk system, to keep us (and maybe users) updated on policy / protocol / structural decisions, and to post reminders and tips so that we will all be able to see them. A flexible "Helpdesk newsletter" of sorts.
+
# Helpdesk news and meeting agendas.
# An internal reference which we Helpdesk staff could use to keep track of our duties and how to perform them effectively.
+
# A consultant guide on how to do our job effectively.
# A "common room" for discussing frequent problems, structural problems, and aspects of our technology/ITS system which we could improve.
+
# A place to discuss structural issues that the Helpdesk deals with, and possible changes.
# A central place to keep resources and links which we all want to have available. (Think Petar's and Amy's links! And I know there are more cool pages and links like those out there... they should be here, available to everyone.)
+
# A central place to keep online resources and links that we want to have available to each other.
 +
 
 +
====Audience====
 +
Anyone who goes to this address can see the Helpdesk public wiki. However, the wiki is not intended to be an end-user product. '''The how-tos and troubleshooting links in these articles are written mainly for Helpdesk use and reference in solving problems.''' We can certainly guide our more adventurous users to the nicer-formatted, more-complete articles if we can't help them directly.
  
 
==Public wiki vs. Internal wiki==
 
==Public wiki vs. Internal wiki==
A glance at the uses listed above make clear the desirability of a restricted-access wiki. While the first three uses are probably fine topics to have on a public wiki, uses 4 and after are a bit more questionable. Some of the content of those topics might be perfectly fine for public eyes; other information is in a "grey area" where, often for security reasons, a lot of information should probably be restricted just to those people who are involved in the Helpdesk workings. Still other information, such as passwords and registration keys, should never go on either wiki at all. (See below).
+
While some of the above uses are useful for public consumption, not all are - particularly items #4, 5, and 6. We have developed an Internal Wiki to contain these resources [https://mediawiki.middlebury.edu/wiki/hi/Index]. This second wiki is only accessible to logged-in users, and only Middlebury users who are currently working at the Helpdesk can log in.
 
 
Our current structure actually involves two wikis: [[Helpdesk|this public wiki ("LIS")]], and the {{hi|Main Page|Helpdesk Internal wiki ("HI")}}. The former can be viewed by anyone in the world, and can be edited by anyone with a Middlebury network account; the latter can only be viewed and accessed by Helpdesk staff and consultants.
 
 
 
--Topher
 
  
 
====Linking between our public and private wikis====
 
====Linking between our public and private wikis====
Thanks to some super-special setup from Joe and Adam, we can easily create links between our public and private wikis. This will let us mesh our wikis together almost as though they were one wiki - but any information that needs to be private will be kept private. To make a link to an article on the Internal Wiki, the format needed will look something like this:
+
You can easily create links between our public and private wikis. This will let us mesh our wikis together almost as though they were one wiki - but any information that needs to be private will be kept private. To make a link to an article on the Internal Wiki, the format needed will look something like this:
  
<code><nowiki>{{hi|ArticleName|text you want to display}}</nowiki></code>
+
<code>
 +
<nowiki>{{hi|ArticleName|text you want to display}}</nowiki> </code>
  
 
Similarly, to make a link from the HI wiki to this wiki ("LIS"), the code will look like this:
 
Similarly, to make a link from the HI wiki to this wiki ("LIS"), the code will look like this:
  
<code><nowiki>{{lis|ArticleName|text you want to display}}</nowiki></code>
+
<code>
 +
<nowiki>{{lis|ArticleName|text you want to display}}</nowiki> </code>
  
 
See also the [[Template:hi|HI linking help]] page.
 
See also the [[Template:hi|HI linking help]] page.
  
 
====Public content vs. private content====
 
====Public content vs. private content====
 +
When editing the wiki, it is important to ask: Is this public content or private content? The basic rule is: '''Any information that could help an intruder to attack or compromise the Middlebury network, should never go on the public wiki.''' Also, some information (passwords, serial keys) shouldn't ever go on either wiki.
  
For a rundown of what information should be kept private, see the {{hi|Main Page|HI Main Page}}.
+
When you want to add some information that ''might'' be a security concern and you're not sure whether to put it on the public or the private wiki, '''choose the private wiki'''.
  
The basic rule is: '''Any information that could help an intruder to attack or compromise the Middlebury network, should never go on the public wiki.''' However, some information (passwords, serial keys) shouldn't go on either wiki at all.
+
==Editing==
 
 
When you want to add some information that ''might'' be a security concern and you're not sure whether to put it on the public or the private wiki, '''choose the private wiki'''.
 
  
If you think you have a better way to state this rule, please talk to Petar, Nate, or someone before changing it. We want your suggestions! But we also need to make sure that this guideline is very clear.  
+
====How to edit====
 +
* To edit you'll need to log in using your Middlebury network credentials. Then, on any page you want to change, click the '''Edit''' tab (or Edit link to the right of the appropriate section, for long pages) and start editing.
 +
* Wiki has its own formatting language that takes some getting used to. (Check in Preferences whether you are using the Javascript-based "rich text" editing toolbar so you can skip over the formatting stuff.) Check out the [[Help:Editing|Editing Help]] page, or just use the Edit tab on this page to study how to make text into headers, '''bold''', ''italics'', [[Helpdesk|linked]], and so forth.
  
--Topher
+
====Organization====
 +
Basically the rule is: Similar pages should have links to each other. Wikis are ''only structured by the links present'' so use links liberally. In our current format, nearly every page has a link from the main [[Helpdesk]] page directly to it, organized by broad categories.
  
==Rules of thumb==
+
====Rules of thumb====
* '''Sign your contributions!''' I'd suggest that when you contribute a major section to the wiki, you sign your name next to it. We can see info on all edits anyway in the History tab, but signing makes it more of a community effort. --Topher
 
 
* If you make a new page, '''make sure there is a link''' from the main page to it. That way we don't "lose" pages, and everyone can reach the new page easily.
 
* If you make a new page, '''make sure there is a link''' from the main page to it. That way we don't "lose" pages, and everyone can reach the new page easily.
 
* '''Adjust the wiki structure as necessary.''' As the wiki grows and pages are added, the table of contents might need adjusting or regrouping. It's up to you to change the wiki structure as needed to make it easy to access what we need to access. (Just make sure you don't lose links to articles along the way! We don't want any orphaned articles that don't have any links to them.)
 
* '''Adjust the wiki structure as necessary.''' As the wiki grows and pages are added, the table of contents might need adjusting or regrouping. It's up to you to change the wiki structure as needed to make it easy to access what we need to access. (Just make sure you don't lose links to articles along the way! We don't want any orphaned articles that don't have any links to them.)
* '''When you're not sure whether to contribute, contribute anyway'''. Err on the side of adding too much. It's easy to take out content or move it to a more relevant section. It's harder to create an environment where everyone feels comfortable jumping in to help. So if you ''might'' have something good to say, say it. Same goes if something isn't worded clearly and you can think of a better way to say it.
+
* '''Err on the side of contributing.''' If you ''might'' have something good to say but you're not sure, just say it. We want your participation in developing the wiki. (But be aware that sensitive information should not go on the public wiki - see above.)
* The exception to this last rule is with '''sensitive information''': if you want to contribute something and you don't know whether it should be on the public or internal wiki, '''stay on the safe side''' and put it in the internal wiki.
+
* When you create a new page, add it to the '''Helpdesk category'''. Do this by mentioning "Helpdesk" in the Categories field when creating a new page.
* When you create a new page, add it to the '''Helpdesk category'''. Do this by adding the '''<nowiki>[[Category:Helpdesk]]</nowiki>''' text to the top of the page.
+
* If your are just adding a placeholder page that needs to be fleshed-out, add the [[Template:Stub|
* Please mark a change as a '''minor edit''' only if you're correcting spelling, correcting a link, correcting formatting, or other small changes like that.
 
* If your are just adding a placeholder page that needs to be fleshed-out, add the '''[[Template:Stub|<nowiki>{{stub}}</nowiki>]]''' text to the top of the page so that others can easily find it. --[[User:Afranco|Franco, Adam]]
 
  
==How to edit==
 
* To edit you'll need to log in using your Middlebury network credentials. Then, on any page you want to change, click the '''Edit''' tab (or Edit link to the right of the appropriate section, for long pages) and start editing.
 
* Wiki has its own formatting language that takes some getting used to. Check out the [[Help:Editing|Editing Help]] page, or just use the Edit tab on this page to study how to make text into headers, '''bold''', ''italics'', [[Helpdesk|linked]], and so forth.
 
  
--Topher
+
<nowiki>{{stub}}</nowiki> ]] text to the top of the page so that others can easily find it.

Revision as of 19:52, 9 October 2008

Information on the purpose of this wiki, what to put in it, how to organize it, how to edit it.

Purpose & Content

This wiki is used for:

  1. Document computer problems and keep up-to-date information on information on specific computer topics.
  2. How-tos for internal (and some external) reference in solving problems.
  3. Clarifying our policies on what services we do and don't provide.
  4. Helpdesk news and meeting agendas.
  5. A consultant guide on how to do our job effectively.
  6. A place to discuss structural issues that the Helpdesk deals with, and possible changes.
  7. A central place to keep online resources and links that we want to have available to each other.

Audience

Anyone who goes to this address can see the Helpdesk public wiki. However, the wiki is not intended to be an end-user product. The how-tos and troubleshooting links in these articles are written mainly for Helpdesk use and reference in solving problems. We can certainly guide our more adventurous users to the nicer-formatted, more-complete articles if we can't help them directly.

Public wiki vs. Internal wiki

While some of the above uses are useful for public consumption, not all are - particularly items #4, 5, and 6. We have developed an Internal Wiki to contain these resources [1]. This second wiki is only accessible to logged-in users, and only Middlebury users who are currently working at the Helpdesk can log in.

Linking between our public and private wikis

You can easily create links between our public and private wikis. This will let us mesh our wikis together almost as though they were one wiki - but any information that needs to be private will be kept private. To make a link to an article on the Internal Wiki, the format needed will look something like this:

{{hi|ArticleName|text you want to display}}

Similarly, to make a link from the HI wiki to this wiki ("LIS"), the code will look like this:

{{lis|ArticleName|text you want to display}}

See also the HI linking help page.

Public content vs. private content

When editing the wiki, it is important to ask: Is this public content or private content? The basic rule is: Any information that could help an intruder to attack or compromise the Middlebury network, should never go on the public wiki. Also, some information (passwords, serial keys) shouldn't ever go on either wiki.

When you want to add some information that might be a security concern and you're not sure whether to put it on the public or the private wiki, choose the private wiki.

Editing

How to edit

  • To edit you'll need to log in using your Middlebury network credentials. Then, on any page you want to change, click the Edit tab (or Edit link to the right of the appropriate section, for long pages) and start editing.
  • Wiki has its own formatting language that takes some getting used to. (Check in Preferences whether you are using the Javascript-based "rich text" editing toolbar so you can skip over the formatting stuff.) Check out the Editing Help page, or just use the Edit tab on this page to study how to make text into headers, bold, italics, linked, and so forth.

Organization

Basically the rule is: Similar pages should have links to each other. Wikis are only structured by the links present so use links liberally. In our current format, nearly every page has a link from the main Helpdesk page directly to it, organized by broad categories.

Rules of thumb

  • If you make a new page, make sure there is a link from the main page to it. That way we don't "lose" pages, and everyone can reach the new page easily.
  • Adjust the wiki structure as necessary. As the wiki grows and pages are added, the table of contents might need adjusting or regrouping. It's up to you to change the wiki structure as needed to make it easy to access what we need to access. (Just make sure you don't lose links to articles along the way! We don't want any orphaned articles that don't have any links to them.)
  • Err on the side of contributing. If you might have something good to say but you're not sure, just say it. We want your participation in developing the wiki. (But be aware that sensitive information should not go on the public wiki - see above.)
  • When you create a new page, add it to the Helpdesk category. Do this by mentioning "Helpdesk" in the Categories field when creating a new page.
  • If your are just adding a placeholder page that needs to be fleshed-out, add the {{stub}} text to the top of the page so that others can easily find it.
Powered by MediaWiki