none
[openafs-wiki.git] / TWiki / GoodStyle.mdwn
1 # <a name="GoodStyle Collaboration Tips"></a><a name="_GoodStyle Collaboration Tips"></a> GoodStyle Collaboration Tips
2
3 - TWiki has very simple **[[text formatting rules|Main/TextFormattingRules]]**. You won't go wrong if you:
4   - start each line without spaces
5   - separate paragraphs with a blank line
6
7 - Run together capitalized words to make **[[WikiWords]]:**
8   - [[WikiWords]] automatically appear as hyperlinks
9   - make up meaningful Wiki names - it can be a challenge (it'll sharpen you up!)
10   - [[WikiWords]] has name-creation tips that may help
11
12 - If a **discussion** is going on:
13   - separate each follow-up with a horizontal rule
14   - add your [[WikiName]] and the date at the end
15   - OR, by all means, insert your comment where it seems to fit best:
16     - you may want to inset it with a bullet and/or _set it in italics_ so it's clear (always sign and date)
17
18 - A good format for a **new topic** is "dissertation followed by discussion":
19   - start with a brief, factual introduction
20   - then bring on the opinions.
21
22 - When a discussion dies down and the page becomes static, feel free to **refactor mercilessly**:
23   - fearlessly edit down to capture the key points
24   - reduce the noise without losing the facts or the flavor
25   - if you merge or delete comments, you can group credit `Contributors:` at the end of the page
26   - That's how Wiki content matures and grows in value over time.
27
28 - For **external site links**, you can type URLs directly into the text - `http://etcete.ra/...` - it'll clear to anyone where they're headed on click.
29
30 - TWiki is intended for world-wide use, and an international **standard date format** like 01 Sep 2001 is preferred. It's universally understood, and clearer than the xx/xx/xx format, where a date like 9/1/01 can mean either Jan or Sep, depending on the local conventions of the readers. For months, use the first three letters: Jan, Feb, Mar, Apr,...
31
32 - Check the source when you want to find out how something is formatted: click <code>**Edit**</code> on the lower toolbar. To see earlier versions, click <code>**More**</code>, then check <code>**Raw text format**</code> and click <code>**View revision**</code>. A bit of HTML experience can't hurt, but you'll soon see with TWiki shorthand how far that is from necessary.
33
34 -- [[PeterThoeny]] - 13 Sep 2001<br /> -- [[MikeMannix]] - 14 Sep 2001 <br />