Compartilhar via


Providing Feedback about the SharePoint Developer Documentation (Uma Subramanian)

I'm a Content Publishing Manager at Microsoft responsible for the SharePoint Foundation 2010 and Business Connectivity Services developer documentation on MSDN. Our deliverables include the SharePoint 2010 SDK (published online and as an offline download), the SharePoint Developer Center, Technical Articles, and Visual How-To’s.

We would like to know what you think about the SharePoint 2010 developer content we've published out on MSDN so far. We are currently focused on identifying and filling gaps in our documentation set, as well as adding best practices guidance.

Here are some of the questions which may guide our conversation:

  • Is the current content set helpful?
  • What do you think are the biggest gaps in our content today?
  • What do you want to see more of? 
  • What can we do better?
  • We’re aware that developers simply love code samples and best practices. What areas would you prefer we target first?

Your input will help our team understand the current needs and prioritize our efforts accordingly. A number of us will monitor this post. I thank you for your time and look forward to your feedback!

-Uma Subramanian [MSFT]

Content Publishing Manager (SharePoint Foundation and BCS)

Comments

  • Anonymous
    December 23, 2010
    The comment has been removed

  • Anonymous
    December 25, 2010
    Is it useful - yes, very. It's definitely better than 2007. However, to try to give useful criticism, there are a couple of areas that could be better. Documentation of CAML isn't great. We're not going to get rid of it, so let's have it accurate and useful. For example the "BaseType" field on a list element (msdn.microsoft.com/.../ms415091.aspx) tells me nothing useful. What does it mean? How might I use it? Similarly with BaseViewID (msdn.microsoft.com/.../ms438074.aspx) - I've been trying to figure out exactly what that's for since 2008. Related: some of the nav could be better. Why are Features and Content Type Defs  second class citizens on another page to this one: msdn.microsoft.com/.../ms462365.aspx ? Why 'Other Schemas'? Secondly, some parts of the documentation seems to have been cut and pasted from 2007 - and it isn't always right - e.g. msdn.microsoft.com/.../bb802730.aspx All in all, better than 2007, but a B+ rather than an A. Oh, and some of the "HOW TO:" articles are just fantastic.

  • Anonymous
    December 28, 2010
    It is great to see how the Microsoft documentation has evolved in the past few years, and the recent efforts to seek users' feedback. As an occasional developer focusing on the client side, I have two main issues. First, it is hard for me to find my way in all the available documentation. I don't understand the logic of having different locations. It would be helpful to have a "global site map". Second, I too often come across this message, especially when looking for Jscript samples: "This language is not supported or no code example is available." I'd like to see a clear statement instead; the Microsoft team should be able to tell whether the language is supported or not. Thanks!

  • Anonymous
    January 06, 2011
    Robert, Andy, and Christophe, Happy New Year and thank you so much for taking the time to tell us the biggest gaps in our content and the things that bother you in the documentation we provide. My team and I currently are looking into the feedback we've received from you. We will get back to you shortly. Thanks, Uma

  • Anonymous
    January 07, 2011
    @Robert, What kind of architectural planning are you looking for in the documentation? Is this more server topologies or planning a large software project? TechNet has some planning and architectural guidance here: technet.microsoft.com/.../cc288426.aspx Also, patterns & practices has documentation around designing a SharePoint application: msdn.microsoft.com/.../ff650022.aspx @Andy, Thanks for the feedback on that! We're trying to think of the best way to work through the CAML schemas. Right now, it simply serves as a reference point rather than actual code-based scenarios using CAML. Also, I'm personally working on getting that erroneous topic fixed. :) @Chrisophe, What, exactly, do you mean by different locations? Are you talking about the table of contents of the SDK or the split between MSDN and TechNet? Maybe something else entirely. :) Also, I'm working with our teams on trying to change the text ("...language not supported..."). The text that you see is generated automatically when there is no code sample for a specific programming language. For example, all of the managed code can be in VB or C# given that it is .NET, but you will see that message if we didn't have time to create examples in both languages. It's a confusing message for sure and thank you for bringing it up! Thanks, Dallas

  • Anonymous
    January 09, 2011
    The comment has been removed

  • Anonymous
    January 10, 2011
    The comment has been removed

  • Anonymous
    January 17, 2011
    The comment has been removed

  • Anonymous
    January 18, 2011
    The comment has been removed

  • Anonymous
    January 18, 2011
    The comment has been removed

  • Anonymous
    January 19, 2011
    The comment has been removed