← Back to team overview

ubuntu-manual team mailing list archive

[Bug 504668] Re: Ordering of content might need some tweaking

 

I don't think that this rearranging is enough. If you look at the
current TOC structure, we start out with a bunch of very general
chapters that really are introductory in nature:

1. An introduction to the manual
2. About Ubuntu in general
3. How to get Ubuntu installed

then we have the one and only chapter on the core use cases:

4. Actually using Ubuntu

followed by a number of more advanced chapters:

5. All sorts of advanced features (customizing)
6. Updating
7. Advanced topics in system maintenance
8. Security

Then we again jump to using the OS:

9. How to use some applications that do not come installed by default

And again we have an advanced chapter:

10. More system maintenance

Note that in all of this, we really have only one chapter (#4) that
describes using Ubuntu, and then a bunch of chapters about doing
advanced things with Ubuntu, or even with applications not part of
Ubuntu by default.

I propose a refinement of the current structure that aligns more with
how people may want to use Ubuntu:

1. Introduction (can keep the current chapter)
2. About Ubuntu (can keep the current chapter)
3. Installation (can keep the current chapter, though minus the discussion on non-Desktop versions; these move to ch 15)
4. Understanding your desktop (keep the "Gnome environment" part of the chapter)
5. Getting online (networking, web browsing, email, IM)
6. Using your peripherals (audio, printing, video, multi-mon, etc; talk about managing media within Nautilus too)
7. Controlling your system (Preferences and Administration menus)
8. Using Ubuntu applications (go over each of the default applications and accessories in the Applications menu)
9. Finding and installing more software (Talk about Software Center, touch on synaptic)
10. Keeping your system working well (talk about Update Manager, and any other novice system maintenance tasks)
11. Keeping your system secure (current chapter 8 is probably fine)
12. Advanced topics: Terminal (current "Introduction to the terminal" section of chapter 7)
13. Advanced topics: Useful extra applications (current chapter 9)
14. Advanced topics: Troubleshooting common problems (current chapter 10)
15. Advanced topics: Learning more about Ubuntu (talk about other distros, and how to learn Linux better)

I think that this approach should be a lot more clear, aligned more with
how people may want to use their computer, leaves all advanced topics
till the end, and in general monotonically increases in complexity
rather than jumping around.

-- 
Ordering of content might need some tweaking
https://bugs.launchpad.net/bugs/504668
You received this bug notification because you are a member of Ubuntu
Manual Team, which is a bug assignee.

Status in Ubuntu Manual: Confirmed

Bug description:
I have been taking a look at our current TOC and am wondering whether it needs to be tweaked slightly. My concern is that we will be asking users to open a terminal and type commands within the first six chapters, however it is not until chapter 7 that we have an 'introduction to the terminal' that explains what it is and what sudo means etc. This doesn't make sense to me and could be confusing/offputting to a beginner.

My suggestion is this:

1. Rename chapter 6 to simply "Updates and Upgrades", and remove the section on "system maintenance".
2. Rename chapter 7 to "System Maintenance", and make the content on system maintenance (that was in chapter 6) a new subsection of chapter 7, following the 'introduction to the terminal' subsection.

That way, I think we could almost get away with not using the command line at all for the entire first part of the manual, as it's mostly gui-based stuff. Then when the reader gets to part II - advanced, the first thing they read is an introduction to the terminal.

Hope that all made sense. Anyone have any other suggestions?





References