Digital Strawberry Girl

A girl-geek's brain dump (Chris Hart's blog)
posts - 134, comments - 70, trackbacks - 109

Who needs documentation?

I was tinkering about with Community Server yesterday to see what it was all about - it looks like a nice enough product, and it should be quite customisable, but finding out how to customise it will be another matter. It seems that much of the documentation is targeted at the day-to-day admins who will use the internal configuration options and settings to get the site looking and working the way they want it to, but when it comes to development-level customisation, where's the information I need? The clue turns out to be on the front page of the default site - a link to the Professional Community Server book on Amazon.

Don't get me wrong, I'm sure it's a great book - the CTO of Telligent has commented as such in a 5-star review on Amazon that:

"You guys wrote a great Community Server handbook that every one of our new, and existing, clients should have in their hands."

Indeed - an extra few dollars in the bank paid for by the developer. I'm all for people writing books about products to provide people with extra insight and useful information, but when it's people working on the product team writing the book, I feel a little bit cheated - if they are going to the trouble of writing about the product, why couldn't they just put the information in their documentation? Or make it clear from the start that they didn't want to provide built-in documentation for developers, and that if you wanted to really customise the product, you'd have to buy the book? The guys behind Community Server, Telligent, are a well-respected crew, so their approach has surprised me. 

Thing is, I'm finding similar frustrations with Microsoft's own documentation these days, although the trend in Microsoft is to get the product teams to blog about how to perform the more advanced tasks that you might want to do with products like SharePoint. MSDN is already vast, massive and unwieldy, but it feels strange and somewhat annoying that all the useful information about SharePoint that I've found is scattered across the blogosphere. It would be really useful if someone could at least collate the most useful and interesting blog posts about each product and compile some kind of official(ish) index of links on MSDN to external sites. New blog posts by Microsoft developers could be linked in to the repository as appropriate and external blog posts could also be added, depending on the quality of the information. It would save developers like me many hours of Googling for information on thing like designing site templates, or creating custom workflows. I guess I could always buy a book, but there just aren't that many unbiased reviews of SharePoint books out there yet. Add to that the fact that I now live near a town, not a big city, so I can't just pop in to a local book store and flick through all the available books (the Computers section in my local Borders is laughably small).

Print | posted on Monday, June 18, 2007 11:16 AM

Feedback

Gravatar

# re: Who needs documentation?

That's exactly my current issue with Community Server. I've been struggling to extend it and add in my own functionlaity using their approved way (i.e. by copying how they've done their data access - .NET 1.1 style providers) and it's not very easy to get into. I know Scott water has just hired some documentation guys for more CS 3.0 docs but it may be a while. Meanwhile, what bugs me the most is that what's changed between service packs is often while defined so incorporating an SP into your own SVN repository is quite awkwrd.

Oh well.
6/18/2007 4:06 PM | Dan
Gravatar

# re: Who needs documentation?

We all live in a yellow submarine...

Your blog right here makes it easy to collect and distribute information.

You said community server developer focus documentation scattered all over the web.

Well I guess one thing you can do is provide an aditional service to your readers, and a service that they can provide to eachother on top of he blog that you write already.

So come on folks. It's up to individuals to do the work that we want to see done. Nothing comes without a price. That's either $$ or work!

I say lets collect all the links we possibly can on developer focused content for Community Server and post them here.

I'l start with one

My Community Server Developer Guide Posts - Keyvan Nayyeri

http://nayyeri.net/archive/2006/04/26/My-Community-Server-Developer-Guide-Posts.aspx

As for sharepoint I believe there's a simpler way to obtain that information. I'll see what I can rummage up from MSDN and the sharepoint blog team :)

Rigel
6/25/2007 7:01 AM | Rigel
Gravatar

# someone was looking for sharepoint development documentation?

Please read this post fully. It is going somewhere. There is a reward at the end also.

Please remember that Microsoft likes to multi-tier their products and documentation.

They typically catagorize their targets into three catagories

* End Users
* Adminisration / IT
* Developers and Webmasters

This beared in mind, if there's any product out there that says it's open to development but you're having difficulty finding the documentation, just look for the associated SDK. A link to the documentation for the SDK should be close at hand.

The reason that microsoft pushes for use of an SDK versus straight coding through text documents and DLL's developed by visual studio is because they can apply greater control to coding conventions and help you spot compile time errors and even run-time errors before you put your product into use.

This is Microsofts initiative to make their software more secure and safer for deployment, in an attempt to reattract enterprise and small business investment into their software, both for networks / end user management and / administration IT / and extensibility development.

Take a look at this as an example

Welcome to the Microsoft Office SharePoint Server 2007 SDK

http://msdn2.microsoft.com/en-us/library/ms550992.aspx

There you go. You can download the sharepoint SDK free of charge. The documentation is included on MSDN or through the built in browser.
6/25/2007 7:10 AM | Rigel
Gravatar

# Were my posts useful?

I forgot to say. I put effort into my coment posts and I try to offer solutions to the problems that people toss out.

Dear DSG: If you find my posts helpful or useful in any way; gawd I hope so; please send me an E-mail saying so and I'll continue to contribute to the dialogue.

If this blog is just to rant about technical difficulties I'll do my best to commiserate, but I really like seeing progress come out of difficulty.

Rigel
6/25/2007 7:24 AM | Rigel
Gravatar

# Community Server Developer Wiki

Community Server Developer Wiki

http://developer.communityserver.org/default.aspx/CS/WelcomeToCommunityServer.html

That was not difficult to find at all.

I just typed "community server developer documenation" at google... Voila.

I hope that helps.

Let me know. You have my addy.

Rigel
6/25/2007 7:30 AM | Rigel
Gravatar

# re: Who needs documentation?

Hi Rigel, thanks for your comments. I will be responding to these in a new post (coming this way as soon as I have a chance to write it), but please understand that, as a former editor at Wrox Press, I now have to live with an inability to read _any_ technical documentation without mentally editing it, thinking about the structure, the scope, and the audience. Documentation is an art - yes, there's a SharePoint SDK, and yes it has information on it, but the quality of that information is very variable. Yes, there's a CS wiki, but a wiki is only as good as the information that's on it, so I guess it's up to all the developers working with CS to help out. Links to any blog posts made about CS should appear on the CS wiki to help build that tool into a more rounded and useful repository of information. Personally, I still prefer reading real, physical books, but with limited funds, I have to be very picky about which books I buy these days.
6/25/2007 11:52 AM | Chris

Post Comment

Title  
Name  
Email
Url
Comment   
Please add 8 and 4 and type the answer here:

Powered by: