One or a few self-contained "slides"
The idea is that a user clicks on an overview or tutorial and sees a
simple self-contained summary that fits in one or a few single pages
(Aside: most overviews still have .gif file slide which was Nick's dumb
idea, but see overview.template
and slide_maker.pm to see how
a reasonable alternative can be made that is much easier to
These "slides" should be:-
After the "slides" come the detailed material which can be broken into
sub-documents and have links to other parts of WebDocs and beyond.
- Self contained. A new postgraduate starting on MINOS should have
sufficient background knowledge to comprehend them in isolation.
- Links are encouraged, but only to other "slides" on other
overviews and tutorials.
The purpose of this rule is twofold:-
For the tutorials orientation and navigation are not the principle
aims. They are end documents in their own right but can still serve
these purposes. Indeed it is important that they contain links to
WebDocs were additional information can be found.
- Orientation. A big problem for newcomers is information
overload. So long as they just navigate within slides they should not
get indigestion. Also, in the early days they can return to any slide
to remind themselves of some key concept.
- Navigation. Having got some level of orientation the next thing a
user wants is to be able to locate more detailed information within
WebDoc. These topic-based pages can have links into the rest of WebDoc
as an alternative to the main index as a way of navigating.