stale_content1Add my vote for this tag create new tag
, view all tags
We should improve the documentation in the TWiki.TWiki web for first time users. The idea is to have a good first time experience for people evaluating the tool or learning to use the tool.

Items to do:

  • Start of from WelcomeGuest in TWiki.TWiki that links to new topics:
  • TWikiFAQ: Frequently asked questions for new users (excluding TextFormattingFAQ), i.e.
  • TWikiTutorial:
    • Gives a tour to learn about TWiki
    • User should be guided through the tour, e.g. step by step instructions of what to do (separate window? Java Script?)
    • Items to cover: (OTOMH)
  • TWikiHelp:
    • Explain the layout of TWiki, e.g. header and footer of a topic when you view, edit, preview, attach...
    • Each page could have a cotext sensitive help, i.e. a Help link on the edit page shows the TWikiHelpOnEdit topic in the Main web.

Anybody up to the task (one of them) ?

-- PeterThoeny - 23 Jun 2000

Funny you should mention this. I am in the midst (about half done) with an entire web (Howto) that functions as a manual and faq for TWiki. Let me bang on it for another day or so and zip it up and upload it; it addresses many of the points above already. I was going to get a lot more done before I sent it, but I don't want to see a lot of duplication of effort, either. If we can come up with a way to make a static page or pages out of a web, we could just turn the Howto web into HTML docs that anyone could get and read.

-- KevinKinnell - 23 Jun 2000

Funny! There is a saying in German, something like "if talk about the devil he will appear" (I don't really imply anthing wink

Great that you are working on it. Take your time, then you can upload it (other people should wait with related documentation).

Regarding the Howto web, what do you think if we put all topics into Main? The Main web is for users and documentation, so it would fit there. What are your ideas to put it in a separate web? (new thread -- kk - 27 Jun 00)

The script that creates the Beta and Production releases already creates HTML documentation of TWikiHistory and TWikiDocumentation. It would be easy to add other topics as well. We could create a big TWikiHowTo topic that includes all relevant Howto topics (TWikiDocumentation is organized already like that).

-- PeterThoeny - 25 Jun 2000

TWiki at the Eifel Forum has some nice introduction to TWiki collaboration, see http://efsa.SourceForge.net/cgi-bin/view/Main/HowWikiWorks.

-- PeterThoeny - 25 Jun 2000

FYI, at Wind River we has a need for a TWikiTutorial topic, so I created one. This is a tutorial (2.5 printed pages) to bring new users up to speed. I will not save it here, lets look at Kevin's docs first.

-- PeterThoeny - 29 Jun 2000

Has something happened in this issue since June? We are currently doing the initial Twiki installation and our webmaster seems to constantly bounce to some non-intuitive things during the installation.

-- JuhaKrapinoja - 27 Nov 2000

(Note: I changed above links to point to the TWiki.TWiki web instead of the TWiki.Main web since all the docs have been moved there)

The TWikiDocumentation has been updated considerably for the new 01 Dec 2000 release (available since 17 Nov 2000 but not announced yet), so installation should go smoother now. We can improve the installation docs further if you can bring some concrete examples (or if you update the docs yourself wink

I just started a TWikiFAQ yesterday, it will grow over time. Any help here is appreciated as well.

What is missing is a TWikiHelp, including context sensitive help.

-- PeterThoeny - 28 Nov 2000

Edit | Attach | Watch | Print version | History: r7 < r6 < r5 < r4 < r3 | Backlinks | Raw View | Raw edit | More topic actions
Topic revision: r7 - 2000-11-28 - PeterThoeny
  • Learn about TWiki  
  • Download TWiki
This site is powered by the TWiki collaboration platform Powered by Perl Hosted by OICcam.com Ideas, requests, problems regarding TWiki? Send feedback. Ask community in the support forum.
Copyright © 1999-2018 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.