Login | Register For Free | Help
Search for: (Advanced)

Mailing List Archive: Apache: Docs
Comments in docs
 

Index | Next | Previous | View Flat


rbowen at rcbowen

May 3, 2012, 6:54 AM


Views: 1675
Permalink
Comments in docs

I've long been a fan of the PHP documentation - specifically, the way that they solicit commentary from readers, and then fold that commentary into the docs. Not only did it encourage me to comment on the docs, it also got me involved in the PHP documentation project, at least marginally. The barrier to entry is so low that all you have to do is be a writer.

As I've said elsewhere, our process seems to require that you be a programmer. I'd like to see what we can do to change that. This is why the docs@ list was split from the dev@ list in the first place. And it was at least in part why we started doing stuff in a wiki, although that hasn't been nearly as successful as I wished.

I'd like to brainstorm about how we can do something like the PHP docs - provide a way for end-users to comment on a given doc, and then have a process for moderating and folding those comments into the docs themselves.

The PHP docs team have offered us, on several occasions, their entire documentation infrastructure. I haven't even bothered to mention that to this list, because it would be an *enormous* change. I've discussed it in person with several docs folks, and the response has consistently been, yeah, that would be cool, but it's too big a change. But I'd be glad to have Phil write up something if people are at all interested.

I digress.

Does anyone know of a way to integrate a third-party comment service like, say, disqus or whatnot, into our docs, so that we could get direct feedback from our audience? Or can you think of another way that we might do this?

Shosholoza.

--
Rich Bowen
rbowen [at] rcbowen :: @rbowen
rbowen [at] apache

Subject User Time
Comments in docs rbowen at rcbowen May 3, 2012, 6:54 AM
    Re: Comments in docs rumble at cord May 3, 2012, 7:25 AM
        Re: Comments in docs i.galic at brainsware May 3, 2012, 9:06 AM
            Re: Comments in docs rbowen at rcbowen May 3, 2012, 9:21 AM
    Re: Comments in docs niq at apache May 3, 2012, 9:08 AM
        Re: Comments in docs i.galic at brainsware May 3, 2012, 9:13 AM
        Re: Comments in docs rbowen at rcbowen May 3, 2012, 9:20 AM
            Re: Comments in docs i.galic at brainsware May 3, 2012, 9:28 AM
                Re: Comments in docs rumble at cord May 3, 2012, 9:55 AM
                    Re: Comments in docs i.galic at brainsware May 3, 2012, 10:07 AM
                        Re: Comments in docs rumble at cord May 3, 2012, 12:55 PM
                            Re: Comments in docs nd at perlig May 3, 2012, 1:06 PM
                                Re: Comments in docs rumble at cord May 3, 2012, 1:14 PM
                                Re: Comments in docs rbowen at rcbowen May 3, 2012, 1:17 PM
                            Re: Comments in docs nd at perlig May 4, 2012, 1:55 AM
                                Re: Comments in docs rumble at cord May 4, 2012, 2:18 AM
                                    Re: Comments in docs nd at perlig May 4, 2012, 2:39 AM
                                        Re: Comments in docs rumble at cord May 4, 2012, 2:48 AM
                                            Re: Comments in docs nd at perlig May 4, 2012, 3:09 AM
                                Re: Comments in docs i.galic at brainsware May 4, 2012, 2:18 AM
    Re: Comments in docs kyanha at kyanha May 3, 2012, 5:13 PM
        Re: Comments in docs rbowen at rcbowen May 3, 2012, 6:02 PM
        Re: Comments in docs rumble at cord May 4, 2012, 1:51 AM

  Index | Next | Previous | View Flat
 
 


Interested in having your list archived? Contact Gossamer Threads
 
  Web Applications & Managed Hosting Powered by Gossamer Threads Inc.