Difference between revisions of "Help:Contents"
Jump to navigation
Jump to search
| Line 25: | Line 25: | ||
* To learn formatting, it is helpful to find an existing wiki article that has the desired format. Click on the "edit" tab to view formatting styles. | * To learn formatting, it is helpful to find an existing wiki article that has the desired format. Click on the "edit" tab to view formatting styles. | ||
| − | * | + | * Adding Images |
| + | ::Most how-to wiki articles should be structured as a step by step linear process. | ||
| + | ::When doing this, don’t use a screen shot for every step unless it is warranted. Instead, use screenshots only for steps that require it for clarity (this could be all of them or just a few) | ||
| + | ::Capture only the context needed for the step, not the whole screen. Include enough context in the shot so that the user does not get lost. | ||
| + | ::Reduce the screenshots by 75% before uploading. (they will still be easy to read) | ||
| + | ::This will ensure that multiple steps are visible on the screen at the same time which is easier to follow than 1 at a time. | ||
* Write in the style of a manual | * Write in the style of a manual | ||
| Line 32: | Line 37: | ||
::ex. Use: "Check the box 'my data has headers'" '''not''': "You will need to check the box 'my data has headers'" | ::ex. Use: "Check the box 'my data has headers'" '''not''': "You will need to check the box 'my data has headers'" | ||
::First or second person point of view narrative examples to avoid are I, my, we, and you | ::First or second person point of view narrative examples to avoid are I, my, we, and you | ||
| − | |||
| − | |||
| − | |||
* Include Version information on each article. Cut and paste the information below into the top of your article and update it as you edit. | * Include Version information on each article. Cut and paste the information below into the top of your article and update it as you edit. | ||
| Line 40: | Line 42: | ||
::<nowiki>*[[Article Creation|Article Created based on version]]: 11.1.4 HF #4</nowiki><br> | ::<nowiki>*[[Article Creation|Article Created based on version]]: 11.1.4 HF #4</nowiki><br> | ||
::<nowiki>*[[Article Last Update|Last Updated with version]]:</nowiki><br> | ::<nowiki>*[[Article Last Update|Last Updated with version]]:</nowiki><br> | ||
| + | |||
| + | * We have enabled drag and drop functionality for adding images and files to wiki articles. Here is a link to an article showing an alternative method [[Adding Images and Attachments to Wiki Articles]] | ||
===[http://internal-wiki.galenhealthcare.com/Galen_Public_Wiki_Priorities Galen Public Wiki Priorities]=== | ===[http://internal-wiki.galenhealthcare.com/Galen_Public_Wiki_Priorities Galen Public Wiki Priorities]=== | ||
Revision as of 19:31, 22 November 2013
Getting started with Wiki
- Tips and tricks for Wiki Formatting
- Editing
- How to rename a page
- Video:Demonstration of editing basics
- Configuration settings list
- MediaWiki FAQ
- How to tell how recently a wiki article has been updated
Wiki Admin Help
- Consult the User's Guide for information on using the wiki software.
Things you shouldn't do in articles
- Mention patient or client names
- Display client connection information or username and password information
- Post confidential or private information of any type
- State something negative about another company or person
- Use inappropriate or vulgar language
Tips on writing articles
- ALWAYS SEARCH FOR EXISTING ARTICLES ON YOUR TOPIC before creating a new one. Edit the existing article or if appropriate, link off of it. The Goal of the wiki is to have one article on each topic and everyone edits the same article.
- To learn formatting, it is helpful to find an existing wiki article that has the desired format. Click on the "edit" tab to view formatting styles.
- Adding Images
- Most how-to wiki articles should be structured as a step by step linear process.
- When doing this, don’t use a screen shot for every step unless it is warranted. Instead, use screenshots only for steps that require it for clarity (this could be all of them or just a few)
- Capture only the context needed for the step, not the whole screen. Include enough context in the shot so that the user does not get lost.
- Reduce the screenshots by 75% before uploading. (they will still be easy to read)
- This will ensure that multiple steps are visible on the screen at the same time which is easier to follow than 1 at a time.
- Write in the style of a manual
- Use an imperative voice, instead of first or second person
- ex. Use: "Check the box 'my data has headers'" not: "You will need to check the box 'my data has headers'"
- First or second person point of view narrative examples to avoid are I, my, we, and you
- Include Version information on each article. Cut and paste the information below into the top of your article and update it as you edit.
- ==Version Information==
- *[[Article Creation|Article Created based on version]]: 11.1.4 HF #4
- *[[Article Last Update|Last Updated with version]]:
- ==Version Information==
- We have enabled drag and drop functionality for adding images and files to wiki articles. Here is a link to an article showing an alternative method Adding Images and Attachments to Wiki Articles