Differences
This shows you the differences between two versions of the page.
Next revision | Previous revision | ||
main:rswtwikirules [2007/03/01 20:39] – tmsadmin | main:rswtwikirules [2008/09/19 09:12] (current) – arnoschoenmakers | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | ====== | + | ====== |
- | ==== Intro: ==== | + | This page contains the introduction to the WSRT Operations Wiki and the guidelines to use it. Users must be familiar with the guidelines before adding or updating information in this Wiki. |
- | We zijn een tijd geleden begonnen met het serieus in gebruik nemen van Twiki als pool voor documentatie en informatie uitwisseling binnen de RSW software ontwikkelgroepen en voor de waarnemers. Dit roept uiteraard vragen op als: wat kan ik in Twiki zetten, hoe ga ik er mee om. Dit document probeert de randvoorwaarden die ik stel voor documentatie in de RSW Twiki site helder te krijgen. Wanneer plaats je documentatie in Twiki, in wat voor vorm doe je dat, hoe gaan we om met Twiki webs, wat zijn de basisregels, | + | ===== Wiki? What Wiki? ===== |
- | ==== Twiki documentatie systeem ==== | + | A Wiki is a place to share information among a group of people. Information is not created by itself; instead, people must create the information so other people can benefit from the shared knowledge. The other people can then use their own knowledge to update existing or add new information. A wiki is therefore a highly dynamic information exchange platform. That some information will be outdated is unavoidable; |
- | TWiki is een specifieke implementatie van een Wiki documentatie systeem met vier belangrijke eigenschappen die het voor die functie geschikt maken: | + | ===== WSRT Operations |
+ | This Wiki exists to collect operations related information of the [[http:// | ||
- | 1) Het is web-based, dus voor iedereen eenvoudig toegankelijk via een webbrowser | + | To navigate this wiki, you can choose one of the sections in the navigation window on the left, or do a ' |
- | 2) je hoeft geen HTML te kennen om in Twiki te kunnen werken. Twiki heeft een eigen syntax die de gebruiker | + | All users are invited (even urged!) to add or update information |
- | 3) Twiki gebruikt een CVS versie beheer systeem om wijzgingen op pagina' | + | When you enter this Wiki for the first time, or without logging in, you have only read access to the public information. The right to make modifications is granted when you have [[this> |
- | 4) In principe kan iedereen informatie toevoegen, veranderen, verplaatsen, | + | All questions and remarks can be send to the [[ro_wiki@astron.nl|administrator]]. |
- | ==== Twiki jargon: ==== | ||
- | Binnen een Twiki omgeving is er wat eigen jargon waarvan het handig is als je daarmee bekend bent: | ||
- | //Twiki Naam:// | + | ===== Using a Wiki ===== |
- | Twiki gebruikt een aparte syntax voor namen die geassocieerd worden met Twiki-eigen gebieden (topics), gebruikers, etc. Dit zijn namen die tegen elkaar aan worden geschreven en minimaal twee hoofdletter bevatten. Voorbeelden zijn ArnoSchoenmakers, | + | |
- | //Twiki Web:// | + | Every Wiki has its own syntax for text markup. Something one just needs to get acquinted to... For this Wiki, a brief explanation can be found [[http://wiki.splitbrain.org/ |
- | Een specifieke omgeving waarbinnen documentatie van een bepaalds onderwerp terug te plaatsen en terug te vinden is. Officieel geldt dat elk web een begrensd samenwerkingsgebied vormt ("an area of collaberation" | ||
- | Twiki webs worden aangeduid als [[start|Twiki.Main]] (Main web), [[CNI: | ||
- | //Twiki Topics:// | + | ===== Some guidelines ===== |
- | Binnen een Twiki web zijn Topics gedefinieerd. Elke Twiki pagina heeft een uniek Topic. Topics kunnen eenvoudig worden aangemaakt door nieuwe pagina' | + | |
- | Twiki topics kunnen ook weer subtopics hebben, en dit kan meerdere lagen diep zijn. Dit kan leiden tot constructies als Twiki.TMS (Topic TMS in het Main web), Twiki.TMS.ProgDoc | + | |
- | //Twiki Users:// | + | There are some simple rules we impose to users: |
- | Twiki Users zijn geregistreerde gebruikers van de Twiki omgeving. Iedereen kan Twiki pagina' | + | * All information should be in English |
+ | * Large documents can be attached. We prefer attached documents to be in pdf-format so they are viewable and printable by most users. | ||
+ | * Images are preferred as either jpg, gif, svg or png, as these are supported by nearly all browsers. | ||
- | //Twiki Syntax en Twiki text:// | ||
- | Dit is de specifieke Twiki taal die een gebruiker in staat stelt eenvoudige opmaak van pagina' | ||
- | //Twiki Attachments:// | + | ===== Preferred page layout ===== |
- | Op iedere Twiki pagina kun je files uploaden. Deze files komen dan in een zgn attachment lijst op de pagina, waar iedereen ze weer kan downloaden voor eigen gebruik. Deze files kunnen door iedereen ge-edit en weer teruggezet worden en bieden dus dezelfde mogelijkheden als Twiki pagina' | + | |
- | //Twiki indeling:// | + | We strive towards a more-or-less uniform presentation of information. We therefore like to see a uniform page layout and navigation style. |
- | De Twiki site heeft geen vaste indeling. Er is een verzameling Twiki webs (die we liefst zo klein mogelijkhouden), | + | |
- | //Twiki links// | + | Most of the pages will simply be pages that lay out the tree structure leading to the desired documentation; |
- | Binnen de Twiki omgeving kun je eenvoudig links aanbrengen door te refereren naar het Twiki Topic van de link. Gebruik NOOIT URLs om binnen Twiki door te verwijzen, dan verlies je de mogelijkheid dat bij het verplaatsen of hernoemen van de pagina waar je naar refereert alle verwijzingen ook vanzelf worden aangepast. Zie de TWiki.TextFormattingRules voor de juiste syntax. | + | |
- | //Twiki search// | + | A //document//-page, on the other hand, contain mostly useful information. Of course, it will also contain some links but its main goal is not re-direct the reader, but to inform the reader. These pages may be referenced from several other (link) pages. The preferred style for a document-page is givene [[main: |
- | Twiki heeft een allerlei zoekmogelijkheid om informatie te zoeken in Twiki pagina' | + | |
- | ==== TWiki inhoud: ==== | ||
- | Het doel van onze Twiki site is enigszins afhankelijk van het beoogde publiek voor de verschillende delen van de site. | ||
- | Voor de software ontwikkelaars is het doel als volgt te definieren: | ||
- | |||
- | - Software ontwikkelaars de mogelijkheid bieden informatie en tools uit te wisselen in een eigen webomgeving | ||
- | - Gebruikers documentatie van zelf-ontwikkelde of veel gebruikte software tools opzetten en in stand houden. | ||
- | - Procedures voor software ontwikkeling opzetten en in stand houden | ||
- | |||
- | Voor WSRT gebruikers (denk aan de waarnemers) is het doel als volgt te definieren: | ||
- | |||
- | - Procedures en geheugensteuntjes voor het waarneemgebeuren opzetten en in stand houden. | ||
- | - Beschrijvingen van veel gebruikte (software) tools beschikbaar maken en bij de tijd houden. Dit is ook een taak van ontwikkelaars voorzover zij tools maken die door waarnemers gebruikt moeten worden (user manuals!). | ||
- | |||
- | ==== RSW Twiki regels: ==== | ||
- | |||
- | Hoewel Twiki floreert door de laagdrempeligheid en de mogelijkeden tot instantane wijzigingen, | ||
- | |||
- | - Twiki namen: Gebruik zoveel mogelijk een Twikinaam die lijkt op je eigen naam. Dus geen HarryPotter als je Jan Klaassen heet. | ||
- | |||
- | - Nieuwe webs: Deze worden alleen gemaakt door ArnoSchoenmakers; | ||
- | |||
- | - Nieuwe topics: Gebruik logische namen. begin een pagina altijd met een kleine beschrijving wat op de pagina te vinden is (paar regels, maximaal). | ||
- | |||
- | - Weggooien van pagina' | ||
- | |||
- | - Externe links: Dit is alles wat verwijst naar lokaties BUITEN de Twiki site (dus ook als het op dezelfde webserver zit). Altijd aangeven dat het een externe link betreft en mede delen dat deze mogelijk onbetrouwbaar is! Voeg dus toe: " | ||
- | |||
- | - Software downloads: Geen links naar download sites; doe liever een download van het product en voeg de file toe als attachment aan de Twiki pagina; dan heeft iedereen ook toegang tot dezelfde versie van het product (wel melden of Linux/ | ||
- | |||
- | - Ondertekening: | ||
- | |||
- | // | ||
- | |||
- | - Probeer zoveel mogelijk documentatie toe te voegen als Twiki text; Alleen als dit veel werk is, of het oorspronkelijke document is in een " | ||
- | |||
- | - Houdt het relevant; bedenk dat het doel is om heldere informatie uitwisseling te genereren. | ||
- | |||
- | - De voertaal is zoveel mogelijk engels, maar ik heb geen problemen met nederlandstalige | ||
- | |||
- | <hr> | ||
- | ---- | ||
- | ArnoSchoenmakers - 06 Apr 2005 | ||
+ | Detailed documantation (i.e. pages with lots of text) should be at the lowest level. |