gnome-display-properties documentation task

[Phil Bull]

Hi Vikram,

On Mon, 2009-09-07 at 18:59 -0400, Vikram wrote:
>            My previous idea seems to be rejected and I agree I should
> have given it more thought, I see that there is no documentation present
> about gnome-display-properties and it was on the to-do list for system
> documentation. I just got familiar with doc-book format and I have
> started writing it I would appreciate any help in this case

Excellent! I've attached a brief (and unfinished) guide to writing
system documentation for you to take a look at.

People (including myself) often neglect the planning stages of writing
documentation, and just start writing. I've since learned that this can
be disastrous, and can lead to documentation which is useless to users.
The attached guide is intended to help people follow good planning
practices. On first inspection it seems like a lot of effort, but I
followed the guide when I was writing some new docs a week ago and I
felt that my output was much better.

Thanks,

Phil

-- 
Phil Bull
https://launchpad.net/people/philbull
-------------- next part --------------
A non-text attachment was scrubbed...
Name: Writing Documentation.odt
Type: application/vnd.oasis.opendocument.text
Size: 30999 bytes
Desc: not available
URL: <https://lists.ubuntu.com/archives/ubuntu-doc/attachments/20090908/8e423730/attachment.odt>