Further wiki gardening (And no more excuses for not contributing to the QuickGuide! :)

[Enrico Zini]

On Sun, Jan 16, 2005 at 12:22:16PM +0200, Sean Wheller wrote:

> I have made valid fixes and restructured. In general I think it is
> best to try contain everything in a single sectN for this book. The
> general logic of the structure is:
> Intro para (description)
> Screen Capt
> Example useage
> Notes, Tips Cautions, Warnings
> Enrico if you agree I will copy this to wiki.

I probably prefer to have the screenshot right at the beginning of the
section, as it complemented the title.  This also allows the text to run
fluently for the rest of the section.

This is probably even more needed in cases that are a bit more
complicated than the Calculator, where the description would be much
longer.

I'd also leave the "see also" part to the end, so that the section
doesn't finish, but continues elsewhere in the real documentation.

I committed a version with these two lines moved, to show what I mean.


As for the tips and examples, I made them into subsections because they
are going to be present in all the applications we cover, so I wanted to
underline that they are an important part of the structure of the
document itself.  Consider also that applications bigger than the
Calculator may have many more examples and tips, and that a chapter for
them may be composed 70/80% by examples and tips.

What is the disadvantage in using subsections?


Ciao,

Enrico

--
GPG key: 1024D/797EBFAB 2000-12-05 Enrico Zini <enrico at debian.org>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 189 bytes
Desc: Digital signature
URL: <https://lists.ubuntu.com/archives/ubuntu-doc/attachments/20050116/a1869387/attachment.pgp>