Discussion:
[OpenAFS-Doc] Format and style for documentation?
David Montuori
2008-07-29 15:08:59 UTC
Permalink
Hello everyone -- first time poster here, redirected from the info list.

In the relatively near future, I'm looking to submit a change to the
existing documentation (the guide). Is there any guide (official or not,
most likely unofficial) to the preferred format and style?

Thanks in advance for any info and help you can provide,

Dave Montuori (new guy at Sine Nomine Associates)
Russ Allbery
2008-07-29 18:30:36 UTC
Permalink
Post by David Montuori
Hello everyone -- first time poster here, redirected from the info list.
In the relatively near future, I'm looking to submit a change to the
existing documentation (the guide). Is there any guide (official or not,
most likely unofficial) to the preferred format and style?
There is not. It's one of the things we'd really like someone who knows
DocBook reasonably well to develop.
--
Russ Allbery (***@stanford.edu) <http://www.eyrie.org/~eagle/>
Charles Curley
2008-07-29 21:58:00 UTC
Permalink
Post by David Montuori
Hello everyone -- first time poster here, redirected from the info list.
In the relatively near future, I'm looking to submit a change to the
existing documentation (the guide). Is there any guide (official or not,
most likely unofficial) to the preferred format and style?
I'm not sure which guide you're referring to. I plan to do some work
on the Quick Start Unix Guide, but it's a low priority.

As part of that I had planned to work out a style guide (which tags to
use for which elements of the document). I haven't started on that, so
if you want to produce a draft, I'd like to look at it and work with
you. This is the sort of thing that should go into the OpenAFS Wiki at
some point. http://www.dementia.org/twiki/bin/view/AFSLore/
--
Charles Curley /"\ ASCII Ribbon Campaign
Looking for fine software \ / Respect for open standards
and/or writing? X No HTML/RTF in email
http://www.charlescurley.com / \ No M$ Word docs in email

Key fingerprint = CE5C 6645 A45A 64E4 94C0 809C FFF6 4C48 4ECD DFDB
Loading...