Difference: GoodStyle (5 vs. 6)

Revision 602 Dec 2001 - MikeMannix

Line: 1 to 1
 

GoodStyle Collaboration Tips

Changed:
<
<
>
>
 
    • start each line without spaces
    • separate paragraphs with a blank line
Changed:
<
<
  • Run together capitalized words to make WikiWords:
>
>
  • Run together capitalized words to form WikiWords:
 
    • WikiWords automatically appear as hyperlinks
Changed:
<
<
    • make up meaningful Wiki names - it can be a challenge (it'll sharpen you up!)
>
>
    • make up meaningful, reasonably brief Wiki names - it can be a challenge (it'll sharpen you up!)
 
    • WikiWords has name-creation tips that may help

  • If a discussion is going on:
Changed:
<
<
    • separate each follow-up with a horizontal rule
>
>
    • separate each follow-up with a space
 
    • add your WikiName and the date at the end
    • OR, by all means, insert your comment where it seems to fit best:
      • you may want to inset it with a bullet and/or set it in italics so it's clear (always sign and date)
Added:
>
>
    • if a sub-topic develops, separate it with a horizontal rule at beginning and end
 
  • A good format for a new topic is "dissertation followed by discussion":
Changed:
<
<
    • start with a brief, factual introduction
    • then bring on the opinions.
>
>
    • start with a brief, factual introduction, followed by double horizontal rules
    • let the discussion begin
 
Changed:
<
<
  • When a discussion dies down and the page becomes static, feel free to refactor mercilessly:
>
>
  • When a discussion dies down and the page becomes static, if you're clear on your course, feel free to refactor mercilessly:
 
    • fearlessly edit down to capture the key points
    • reduce the noise without losing the facts or the flavor
Changed:
<
<
    • if you merge or delete comments, you can group credit Contributors: at the end of the page
    • That's how Wiki content matures and grows in value over time.
>
>
    • if you merge or delete comments, group credit Contributors: at the end of the page
    • This is how Wiki content matures and grows in value over time.
 
  • 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.

  • 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,...
Changed:
<
<
  • Check the source when you want to find out how something is formatted: click Edit on the lower toolbar. To see earlier versions, click More, then check Raw text format and click View revision. A bit of HTML experience can't hurt, but you'll soon see with TWiki shorthand how far that is from necessary.
>
>
  • TIP: Check the source when you want to find out how something is formatted: click Edit on the lower toolbar. To see earlier versions, click More, then check Raw text format and click View revision. A bit of HTML experience can't hurt, but you'll soon see with TWikiShorthand how far that is from necessary.
 
Changed:
<
<
-- PeterThoeny - 13 Sep 2001
-- MikeMannix - 14 Sep 2001
>
>
-- MikeMannix - 01 Dec 2001
 
This site is powered by the TWiki collaboration platform Powered by PerlCopyright © 1999-2020 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback
Note: Please contribute updates to this topic on TWiki.org at TWiki:TWiki.GoodStyle.