Re: good style guides for python-style documentation ?



Fredrik Lundh wrote:
(reposted from doc-sig, which seems to be mostly dead
these days).

over at the pytut wiki, "carndt" asked:

Are there any guidelines about conventions concerning
punctuation, text styles and language style (e.g. how
to address the reader)?

any suggestions from this list ?

</F>

Documenting Python http://docs.python.org/dev/doc/style-guide.html
recommends Apple Publications Style Guide:
http://developer.apple.com/referencelibrary/API_Fundamentals/UserExperience-fund-date.html

GNOME Documentation Style Guide is also quite useful:
http://developer.gnome.org/documents/style-guide/ .

Ziga

.


Loading