[OpenAFS-Doc] Format and style for documentation?

Charles Curley charlescurley@charlescurley.com
Tue, 29 Jul 2008 15:58:00 -0600


--rS8CxjVDS/+yyDmU
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline
Content-Transfer-Encoding: quoted-printable

On Tue, Jul 29, 2008 at 11:08:59AM -0400, David Montuori wrote:
> Hello everyone -- first time poster here, redirected from the info list.
>=20
> 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/

--=20

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 =3D CE5C 6645 A45A 64E4 94C0  809C FFF6 4C48 4ECD DFDB

--rS8CxjVDS/+yyDmU
Content-Type: application/pgp-signature; name="signature.asc"
Content-Description: Digital signature
Content-Disposition: inline

-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.6 (GNU/Linux)

iD8DBQFIj5Jo//ZMSE7N39sRAg4/AJ0Tk2G8kUINWvhCNo3VOSgxULE8LACghEhZ
KPDbKIrwYnCiRKBYFfitYvo=
=ZxkX
-----END PGP SIGNATURE-----

--rS8CxjVDS/+yyDmU--