{"id":26717,"date":"2016-07-21T08:16:27","date_gmt":"2016-07-21T15:16:27","guid":{"rendered":"https:\/\/blog.xamarin.com\/?p=26717"},"modified":"2016-07-21T08:16:27","modified_gmt":"2016-07-21T15:16:27","slug":"introducing-stack-overflow-documentation","status":"publish","type":"post","link":"https:\/\/devblogs.microsoft.com\/xamarin\/introducing-stack-overflow-documentation\/","title":{"rendered":"Introducing Stack Overflow Documentation"},"content":{"rendered":"<p>\t\t\t\tXamarin and Microsoft are excited to be a part of the launch of <a href=\"http:\/\/blog.stackoverflow.com\/2016\/07\/introducing-stack-overflow-documentation-beta\/\">Stack Overflow Documentation<\/a>. This new feature brings the same collaborative approach from <a href=\"https:\/\/stackoverflow.com\/\">Stack Overflow&#8217;s question-and-answer<\/a> system to developer documentation.\n<a href=\"http:\/\/stackoverflow.com\/documentation\/\" target=\"_blank\"><img decoding=\"async\" class=\"aligncenter size-full wp-image-26740\" src=\"https:\/\/devblogs.microsoft.com\/wp-content\/uploads\/sites\/44\/2019\/03\/stackoverflowdocs.png\" alt=\"stackoverflow documentation\" width=\"535\" height=\"150\" \/><\/a><\/p>\n<p>Stack Overflow Documentation provides a set of edit and review tools that lets the community write example-focused documentation to complement our existing developer portal and samples at <a href=\"http:\/\/developer.xamarin.com\/\">developer.xamarin.com<\/a>. Stack Overflow badges and reputation are supported, so every contribution you make is recognized; the more docs you contribute, the more rep you earn!<\/p>\n<h2>How does it work?<\/h2>\n<p>The new site will be organized by <a href=\"http:\/\/stackoverflow.com\/documentation\" target=\"_blank\">Stack Overflow <i>tags<\/i><\/a> (such as <code>Xamarin.iOS<\/code> and\u00a0<code>Xamarin.Android<\/code>) which will contain documentation <i>topics<\/i> with many <i>examples<\/i>.<\/p>\n<p>Browsing the documentation is as easy as using Stack Overflow: you can navigate by tag, topic, or search. If you can&#8217;t find the documentation you&#8217;re looking for, suggest someone write it (or if you know about a particular subject, write it yourself).<\/p>\n<h2>How to Contribute<\/h2>\n<p>Stack Overflow users can:<\/p>\n<ul>\n<li>Suggest topics that they would like to see documented, for others to write.<\/li>\n<li>Create a topic they are knowledgeable on, and immediately add examples.<\/li>\n<li>Add examples to existing topics.<\/li>\n<\/ul>\n<p>Each topic can have a number of examples to demonstrate how to accomplish different tasks. Examples can have the following four elements:<\/p>\n<ul>\n<li><b>Examples<\/b>: Topics should <i>always<\/i> include working code examples.<\/li>\n<li><b>Syntax<\/b>: Add method signatures if they aren&#8217;t obvious.<\/li>\n<li><b>Parameters<\/b>: Explain what parameters are for and any constraints they must adhere to.<\/li>\n<li><b>Remarks<\/b>: Describe any additional rules or pitfalls that aren&#8217;t covered in the code examples.<\/li>\n<\/ul>\n<p>Submissions will be peer-reviewed; the site includes the ability to share drafts and chat with other contributors before an example is published.<\/p>\n<h2>Get Started<\/h2>\n<p>Xamarin tags are set up and ready for contributions, as this screenshot demonstrates:<\/p>\n<p><a href=\"http:\/\/stackoverflow.com\/documentation\/xamarin.ios\/\" target=\"_blank\"><img decoding=\"async\" class=\"aligncenter size-full wp-image-26731\" src=\"https:\/\/devblogs.microsoft.com\/wp-content\/uploads\/sites\/44\/2019\/03\/xamariniosSODocumentation.png\" alt=\"Xamarin.iOS on Stack Overflow Documentation\" width=\"1092\" height=\"471\" \/><\/a><\/p>\n<p>We&#8217;re excited to see what great examples our developer community create and share!<\/p>\n<p>Visit <a href=\"https:\/\/stackoverflow.com\/documentation\/\">stackoverflow.com\/documentation<\/a> to get started today.\t\t<\/p>\n","protected":false},"excerpt":{"rendered":"<p>Xamarin and Microsoft are excited to be a part of the launch of Stack Overflow Documentation. This new feature brings the same collaborative approach from Stack Overflow&#8217;s question-and-answer system to developer documentation. Stack Overflow Documentation provides a set of edit and review tools that lets the community write example-focused documentation to complement our existing developer [&hellip;]<\/p>\n","protected":false},"author":570,"featured_media":39167,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"footnotes":""},"categories":[2],"tags":[11,4],"class_list":["post-26717","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-developers","tag-education","tag-xamarin-platform"],"acf":[],"blog_post_summary":"<p>Xamarin and Microsoft are excited to be a part of the launch of Stack Overflow Documentation. This new feature brings the same collaborative approach from Stack Overflow&#8217;s question-and-answer system to developer documentation. Stack Overflow Documentation provides a set of edit and review tools that lets the community write example-focused documentation to complement our existing developer [&hellip;]<\/p>\n","_links":{"self":[{"href":"https:\/\/devblogs.microsoft.com\/xamarin\/wp-json\/wp\/v2\/posts\/26717","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/devblogs.microsoft.com\/xamarin\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/devblogs.microsoft.com\/xamarin\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/xamarin\/wp-json\/wp\/v2\/users\/570"}],"replies":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/xamarin\/wp-json\/wp\/v2\/comments?post=26717"}],"version-history":[{"count":0,"href":"https:\/\/devblogs.microsoft.com\/xamarin\/wp-json\/wp\/v2\/posts\/26717\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/xamarin\/wp-json\/wp\/v2\/media\/39167"}],"wp:attachment":[{"href":"https:\/\/devblogs.microsoft.com\/xamarin\/wp-json\/wp\/v2\/media?parent=26717"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/xamarin\/wp-json\/wp\/v2\/categories?post=26717"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/xamarin\/wp-json\/wp\/v2\/tags?post=26717"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}