• Do not register here on develop.twiki.org, login with your twiki.org account.
• Use View topic Item7848 for generic doc work for TWiki-6.1.1. Use View topic Item7851 for doc work on extensions that are not part of a release. More... Close
• Anything you create or change in standard webs (Main, TWiki, Sandbox etc) will be automatically reverted on every SVN update.
Does this site look broken?. Use the LitterTray web for test cases.

Item3738: Avoid "detailed instructions are beyond the scope of this document"

Item Form Data

AppliesTo: Component: Priority: CurrentState: WaitingFor: TargetRelease ReleasedIn
Engine   Normal Closed   minor 4.1.3, 4.2.0

Edit Form Data

Summary:
Reported By:
Codebase:
Applies To:
Component:
Priority:
Current State:
Waiting For:
Target Release:
Released In:
 

Detail

Users expect to find documentation that is easy to follow. TWikiInstallationGuide has a "detailed instructions are beyond the scope of this document", which basically tells to user to go away if you do not know what we are talking about. I suggest to change the doc to be crisp, and to add specific pointers where needed. http://www.wikimatrix.org/forum/viewtopic.php?pid=963 prompted me to create this bugs item (it has some additional suggestions as well.)

-- TWiki:Main/PeterThoeny - 08 Mar 2007

Dammed. I thought the same the day I was changing the INSTALL.html to be a built version of TWikiInstallationGuide. But I forgot and never returned to remove it. It is pretty silly to have this in the document.

Especially because the thing it says is beyond the scope of the document is actually well described. I added that a few revisions ago like giving the TWiki:TWiki.ApacheConfigGenerator link which I can see has helped a lot for new installers.

-- TWiki:Main.KennethLavrsen - 08 Mar 2007

Very quick fix, excellent! smile

-- TWiki:Main.PeterThoeny - 08 Mar 2007

ItemTemplate
Summary Avoid "detailed instructions are beyond the scope of this document"
ReportedBy TWiki:Main.PeterThoeny
Codebase 4.1.2
SVN Range TWiki-4.1.2, Sat, 03 Mar 2007, build 13043
AppliesTo Engine
Component

Priority Normal
CurrentState Closed
WaitingFor

Checkins TWikirev:13089 TWikirev:13090
TargetRelease minor
ReleasedIn 4.1.3, 4.2.0
Edit | Attach | Watch | Print version | History: r10 < r9 < r8 < r7 < r6 | Backlinks | Raw View | Raw edit | More topic actions
Topic revision: r10 - 2008-01-22 - KennethLavrsen
 
This site is powered by the TWiki collaboration platform Powered by PerlCopyright © 2008-2019 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback