Opened 5 years ago

Last modified 5 years ago

#16192 assigned bug

Reorder sections of the user guide

Reported by: pulkomandy Owned by: humdinger
Priority: normal Milestone: Unscheduled
Component: Documentation Version: R1/Development
Keywords: Cc:
Blocked By: Blocking:
Platform: All

Description

Some users trying Haiku for the first time and getting a bit confused: https://www.cpcwiki.eu/forum/emulators/ace-for-haiku/msg187763/#msg187763

The user guide starts with the bootloader menu and digs directly into the filesystem structure, and goes on with stack and tile and keyboard shortcuts.

This does not seem to be the best approach. Shouldn't we start with the basic things: starting apps from the Deskbar menu and finding files in Tracker? And cover the more advanced topics later on in the guide?

Change History (4)

comment:1 by waddlesplash, 5 years ago

Owner: changed from nielx to humdinger
Status: newassigned

comment:2 by humdinger, 5 years ago

I started the thread "Reorder sections of the user guide" at the haiku-doc mailing list to get more input.

comment:3 by lelldorin, 5 years ago

I dont know why my answer on the Mailing list does not listed, here my answer:

We need to thinking like a user here, we need to look from the point that the system is already installed (installation guide).

So the user is looking for?

  • apps
  • settings
  • how to use the system
  • Workshops
  • there he can get help
  • system specific things like filetype, add-ons, driver... are the Last chapter here.

Regards Christian

comment:4 by humdinger, 5 years ago

This ticket is about re-ordering the existing chapters of the user guide. An actual overhaul of the whole thing would be another ticket... I wouldn't think it's needed, Haiku's documentation has been praised by reviewers in the past.

The general issue, as with all documentation, is to get people to read it. As the forum post PulkoMandy linked to demonstrates. I believe with the inclusion of the Quick Tour - however mangled it came out of the userguide/welcome online tool - we now provide a nice intro for people to get a quick overlook of Haiku's essentials.

Note: See TracTickets for help on using tickets.