Guilde to writing guide..

[Paul Schulz]

Greetings,

Just browsing the IRC meeting logs from last night.

My apologies for not being able to get to the meeting.. I tried, but
slept through the alarm (0.30am local time).

A suggestion for the ubuntu-server 'how to get involved' documentation
is a 'guide on how to write guides',  particularly on being clear what
information the guide covers, what is doesn't cover (so it can be
added later or referenced elsewhere), and who the intended audience
is.

eg. The recent emails about sending out a email when a system reboots.

- Intended audience
- What this guide covers
- What this guide doesn't cover

Questions that I know I will have for any change to my system..

- What passwords/secrets are required?
- How is this configuration backed up? (printed notes? local
configuration guide)
   - How does this fit into my local disaster recovery plan?
- What packages does this configuration depend on?
- Will this change be maintained if I upgrade?
- Is there a better way to do this?
  - What alternatives are there?

Some other questions:

- Is there a Debian package for this yet?
- Can I script these changes?
    "cat 'options' > file" works but there are better ways.
    grep -v, debconf, others?

Cheers,
Paul