MicrosoftDocs / feedback

📢 docs.microsoft.com site feedback
https://learn.microsoft.com
Creative Commons Attribution 4.0 International
239 stars 160 forks source link

Missing all Details fo SharePoint API Documentation #693

Open SharePointGuys opened 6 years ago

SharePointGuys commented 6 years ago

🛑 IMPORTANT: You can get your feedback addressed faster if you use the comment section for the article in which you encountered a problem.

Link to article: for example: https://docs.microsoft.com/en-us/dotnet/api/microsoft.sharepoint.spweb?view=sharepoint-server There is no any details such as explanation, examples in the page but was existing in the original MSDN site. Actually all SharePoint related documentation is incomplete after migration, missing all details.

Problem: The tech articles on docs.microsoft.com for SharePoint lost all detailed explanation and example. Another link (https://docs.microsoft.com/en-us/dotnet/api/microsoft.sharepoint.spsite?view=sharepoint-server). Please compare the original MSDN site for SPSite class, SPWeb class, you will find lots of content is missing after migrating to docs.microsoft.com.

SharePointGuys commented 6 years ago

Here I listed 2 links from original MSDN site. Please compare the pages, and you would tell how much details are lost in Microsoft Docs. Thanks.

Original SPWeb Class on MSDN: https://msdn.microsoft.com/en-us/library/microsoft.sharepoint.spweb_members.aspx vs. https://docs.microsoft.com/en-us/dotnet/api/microsoft.sharepoint.spweb?view=sharepoint-server

Original SPSite Class on MSDN: https://msdn.microsoft.com/en-us/library/microsoft.sharepoint.spsite_members.aspx vs. https://docs.microsoft.com/en-us/dotnet/api/microsoft.sharepoint.spsite?view=sharepoint-server.

bsimser commented 6 years ago

The original docs (I'm assuming since I've never seen the original source code) probably came from triple-slash source code comments. Many of original comments though were pretty useless. "A Boolean value that specifies whether the current user is allowed to edit master pages." for a property called AllowMasterPageEditingForCurrentUser is redundant. I'm assuming the new pages are also being generated from assemblies or something. If you edit any of the new pages the markup isn't markup, it's XML that looks like it came from some tool and editing it manually is futile. I don't know what the answer is but I agree the original docs, as somewhat useless as they are, have more information than the current pages. Many times I came to these pages hoping to find out something without getting any more information than what my IDE would tell me. What we need, regardless of the generation of the pages, is a way to contribute content like examples and meaning behind the properties and values.

dend commented 6 years ago

Re-assigning to @jmazzotta, who is currently working with the Office team on migrating the SharePoint APIs.

@bsimser we do generate the documentation automatically, however we also want to preserve the content integrity. We are currently assessing how we can integrate content from MSDN into the docs on docs.microsoft.com.

Troi7 commented 5 years ago

Any update for SharePoint developers? SharePoint Server API documentation is still empty... I can't believe it. It's already several months.

Powerhelmsman commented 5 years ago

@jmazzotta Any updates so far?