[svlug] GIOVANNI RE'S MODEST EVOLUTIONARY DOCUMENTATION PROPOSAL - Re: Understanding the problem... jor

giovanni_re john_re at fastmail.us
Thu May 6 16:32:59 PDT 2010


Hi Don :)  Thanks for your great suggestions :)

Given your 1) Communications to the free sw community abilities, & 2) technical expertise,
& please see also my reply to Luke's post, which references your comments here,

1) I think it would be valueable to the free sw community to alert them to the possibilites & opportunities of the "wiki's for sw documentation" - ideas I suggested, & you & Luke have added thoughts to so far. - What suggestions do you have for useful ways to alert more people about this idea? - articles, news websites, slashdot, digg, redit, linux.com,.....?

2) RE my comments in my reply to luke re next step being creation of a website, mailing list, wiki to discuss & work together to help bring these ideas to reality:  What suggestions do you have re: easy/existing technology to use that will enable an easy to setup & maintain website, mail list & wiki & perhaps git system to help get this idea going?

Re #2: I could set up a google website & mailing list in about a half hour. What other things: sourceforge, github, wikipedia, ??? do you know of that are useful & easy to implement systems/tools for that??

:)



On Thu, 6 May 2010 09:59:20 -0700, "Don Marti" <dmarti at zgp.org> said:
> begin Luke S Crawford quotation of Thu, May 06, 2010 at 11:04:59AM -0400:
> 
> > I mean, I like wikis;  that's how I document stuff at my own business.  
> > But, if you don't have someone watching the dang thing, you /will/ have 
> > a spam problem.
> 
> You also have the dreaded out of date free software
> documentation problem.
> 
> I'm facing this right now in Python web development --
> Google is your friend until the API changes, then all
> the stuff that doesn't work on the current version
> turns into info-poison.
> 
> You could get login-free editing using something like
> the "fork this" functionality on GitHub.  Come up
> with something that's relevant to the software on
> example.org, and "git clone" the project's source
> tree, either onto your own machine or onto a sandbox
> machine somewhere.  Then edit a file under /doc, build
> and preview the docs, and ask a maintainer to pull.
> 
> Ikiwiki maintains its docs in a wiki, and has some
> good DVCS workflow for dealing with spam:
>   http://ikiwiki.info/tips/spam_and_softwaresites/




More information about the svlug mailing list