Chipping in....

The wiki based nature of solr's documentation is rather different
compared to most payware and some open source products. However once
you get used to its "style" I found it quite adequate.

I also dawned on me that portions of Solr are advancing very quickly and
that the wiki style of documentation is the simplest method of allowing
the documentation to keep pace with the code. In my experience payware
products often have "proper" documentation that trails the state of the
code by years in some cases. New functionality is only described in the
release notes. I also ran into cases where vendors refused to fix simple
features as it would require changing the documentation. I quite like the
wiki!

However some of the pages are a mix of cookbook, examples and documentation
and are too big.


, On 24/02/2010 19:20, straup wrote:
> I actually found the documentation pretty great especially since (my 
> experience, anyway) most Java projects seem to default to generic 
> JavaDoc derived documentation (and that makes me cry).
> 
> That said, more cookbook-style "recipes" or stories would be helpful for 
> some of the more esoteric parts of Solr.
> 
> Also: real-time indexing and geo.
> 
> Cheers,
> 
> On 2/24/10 9:54 AM, Grant Ingersoll wrote:
>>
>> On Feb 24, 2010, at 11:08 AM, Stefano Cherchi wrote:
>>
>>> Decent documentation.
>>
>> What parts do you feel are lacking?  Or is it just across the board?  Wikis 
>> are both good and bad for documentation, IMO.
>>
>> -Grant
> 
>  

-- 

======================================================================
Fergus McMenemie                Email:fer...@twig.me.uk
Techmore Limited,               Phone:(UK) 07721 376021
Old Stables, Far End,           Home: (UK) 01522 810839
Boothby Graffoe, Lincoln,
LN5 0LG, England

Unix/Mac/Intranets/WWW          Analyst Programmer
======================================================================

Reply via email to