DocCheck ®

Flexikon: Best Practices

Adding new pages to the Flexikon or changing an existing article is very simple (please view help for beginners). Though, a WikiWikiWeb grows best and reaches the highest value and usability, if the authors stick to some minimal rules. The WikiWikiWeb exists since 8 years and many people have invested there thoughts and ideas concerning these rules, mainly in the "original" Wiki.

We should stick to these experiences. Moreover, we should work out our own rules, specifically adjusted to medical / scientific content and discussions, which will probably be a long but also necessary process.

We need to keep in mind that the Flexikon is an open platform and try to keep the barrier to participate as low as possible. The rules should not demotivate anybody's wish to partipate. Better a good idea in the "wrong" place than nowhere ;) . The following rules should be understood more like an orientation guide for experienced users and inspire some discussion about the project.

Table of contents

Add a new article

Please find some technical guidelines on our help page. Besides that we have collected some helpful suggestions how to start:

Before you add a new article to the Flexikon you should definitely try to find out, whether the same or a similar article does already exist. Use our search function for a quick overview on your theme. In a next step you should think about adding your content to an existing article. Please do not add a new very short article if the topic can be described within some sentences on an existing page.

If you are adding a new article to the Flexikon, please choose a clear name for the page. Normally, this name should be in singular.

Please start each article with a brief introduction. This abstract should explain the content of the following article. Keep in mind that an imprecise introduction might easily cause huge articles with a collection of topics, which are complex and hardly managable.

A diligent linking of your page with other existing pages helps the user to find your article. Please view Flexikon: Links.

Add or edit content

If you want to add some information (Flexikon: Help for beginners), please take care to edit an article that maches the theme.

Style

In most cases it is best to write your article third-person and unsigned. The author of an article is normally secondary. Therefor it is advisable to use the first person only in exceptional cases.

Structure

There are several possibilities to structure your text. These are the most important ones:

Links

The good linking of articles simplifies the navigation and potentiates the knowledge. Linking aticles is very easily done in the Flexikon (Flexikon: Links). Please add some relevant links at the end of your article below a parting line (--``--).

Overview

Overview pages can simplify the access to complex themes.

Eliminate mistakes

One of the big advantages of the Flexikon is that everybody can fix mistakes him/herself.

If you find an obvious mistake, e.g. spelling mistakes, wrong links etc., please correct it right away and it will be a help for everybody. Please add a short comment in the "Edit summary" field below the edit box.

In case of bigger mistakes you should think about changing the article directly (please add a short comment) or alternatively start a discussion by adding a comment directly into the article. Normally, we would ask you to fix the mistake directly, as the structure of the article remains intact in this way. Anybody, who does not like this change can than start a discussion in a second step.

Add comments

Before you add a comment, please think about directly adding your thoughts to the article. There are two ways to add a comment:

1. Insert a new line at the respective position in the text. Type in a space and a star (*) and add you comment (as short as possible). It is common to add your name and the actual date. If you are logged in just use @``SIG``@ .

2. Or add a parting line at the end of the article (-``--``-) and add your comment as described above.

Discussions

Whoever wants to answer to a comment, please think first whether it is possible to summarise some of the comments made so far. Please add a new row, type in one more space than in the line above and a star (*) followed by your comment. If the discussion gets to long, it might make sense to open a new subpage with a name like ["/discussion"].

The Flexikon is no newsgroup

Please do not use the Flexikon for discussions as known from newsgroups, i.e. several contributions following eachother, accompanied by greetings etc.

The Flexikon is meant for another kind of communication. In contrast to a newsgroup you may

1. restructure an existing article and add your own thoughts directly to the text.
2. rephrase or even delete existing pages.

To keep the discussion fair, please stick to the best practices (e.g. do not simply delete an opposite view, but take a look into it). Though in some cases it might be the best way to completely delete an overflowing discussion. In this case please make sure to add a short comment at "Edit summary".

Rename a page

It can sometimes make sense to rename an article, e.g. if you have an idea of a more precise headline for a certain theme. If you want to change a page's name, please stick to the following procedure:

  1. Think thoroughly whether the new name does really make sense ;)
  2. Create a page with the new name.
  3. Open the edit box of the old page (best in a new window of your browser).
  4. Transfer the content of the old page via cut&paste to the new page.
  5. Add a comment like: "Moved here by ...".
  6. Safe the new page.
  7. Write the following on the old page: #``redirect !NewName and below: Delete``This``Page. Therby all visitors will be redirected to the new page for the following 2 weeks.
  8. Add a comment like: "Moved to ..., because ...".
  9. Safe the old page.
  10. Click on "What links here" in the menu of the old page to check whether it is linked on other pages.
  11. Change the links within these articles to your new page.

Be sure: This sounds more complicated than it will be.


Flexikon
Search

Rummage

All pages

Random page

New pages
Take Part

New page

Bug reports

Important Hint | Start | About Flexikon | Help |