Skip to Content.
Sympa Menu

sm-discuss - Re: [SM-Discuss] Tome vote results

sm-discuss AT lists.ibiblio.org

Subject: Public SourceMage Discussion List

List archive

Chronological Thread  
  • From: Eric Sandall <eric AT sandall.us>
  • To: sm-discuss AT lists.ibiblio.org
  • Subject: Re: [SM-Discuss] Tome vote results
  • Date: Thu, 08 Oct 2009 15:34:44 -0700

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

flux wrote:
> Donald Johnson (ltdonny AT gmail.com) wrote [09.10.08 16:34]:
>> First, line wrap? Or it might just be my mail client bugging me.
>>
>> Bor Kraljic wrote:
>>> - it would be nice to have man pages also on wiki. Even better would
>>> be if it would be the same source and then copied to wiki. so your
>>> team has to write it only once.
>> I disagree. I feel the wiki documentation and the man-page
>> documentation should be worded differently, possibly by different
>> authors so that users can cross-reference the documentation and have
>> points clarified. However, regardless, both types of documentation
>> should cover the same functions.
>
> This functionality can (and should) be derived from having different
> people *review* the same document, rather than by having the same
> document rewritten by multiple people. Having it rewritten essentially
> duplicates work. For an example of how simply reviewing a single
> document can work, see the revision history of
> http://www.sourcemage.org/Tome/DocumentGuidelines. ;)

I think you meant http://www.sourcemage.org/Tome/DocumentationGuidelines :)

I agree, we should have one source for all documentation (where
applicable). One spot to put documentation (e.g. wiki and SMGL-specific
man pages) and have it generated into the appropriate format (e.g.
DocuWiki and man, respectively).

The less duplicate work we have to do, the better. A similar idea,
probably not related to Tome, would be auto-generated commit or HISTORY
entries, the auto-generated based on the manually entered.

- -sandalle

- --
Eric Sandall | Source Mage GNU/Linux Developer
eric AT sandall.us PGP: 0xA8EFDD61 | http://www.sourcemage.org/
http://eric.sandall.us/ | http://counter.li.org/ #196285
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.10 (GNU/Linux)
Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org/

iEYEARECAAYFAkrOaQQACgkQHXt9dKjv3WEi6QCguLxj6Ggx2J3/xNUcVeW7NfO8
uaUAoKQGDbAL8jaDG0RzwDTIqju5sNZB
=FjCG
-----END PGP SIGNATURE-----




Archive powered by MHonArc 2.6.24.

Top of Page