{"id":1240,"date":"2024-05-22T12:54:12","date_gmt":"2024-05-22T17:54:12","guid":{"rendered":"https:\/\/readmeprd.wpenginepowered.com\/?p=1240"},"modified":"2024-10-31T10:43:09","modified_gmt":"2024-10-31T15:43:09","slug":"workflow-collaborative-documentation-with-suggested-edits","status":"publish","type":"post","link":"https:\/\/readme.com\/resources\/workflow-collaborative-documentation-with-suggested-edits","title":{"rendered":"Workflow: Collaborative Documentation with Suggested Edits"},"content":{"rendered":"<p>Recently, we released a brand new version of our <a href=\"https:\/\/blog.readme.com\/new-improved-suggested-edits\/\">Suggested Edits feature<\/a> and as we were testing it internally, it dramatically changed how we approached writing documentation. It\u2019s allowed us to more easily collaborate on documentation and merge updates exactly when features go live.<\/p>\n<p>For all major changes to documentation (whether it be new features, major changes to existing features, or even just improving an existing page) all of the edits occur in suggested edits. After a suggested edit is created, the original creator can keep making changes. It&#8217;s no longer necessary to get it finished and perfect on the first try\u2014which means that as a feature is being developed, the documentation can be writing incrementally over time.<\/p>\n<figure class=\"kg-card kg-image-card kg-width-wide\"><img decoding=\"async\" src=\"https:\/\/blog.readme.com\/content\/images\/2019\/02\/Screenshot_2019-02-01-Suggested-Edits.png\" class=\"kg-image\" alt loading=\"lazy\"><\/figure>\n<p>Once the documentation is ready for review, an admin can take a look and leave comments on anything they notice, and even make changes themselves! Documentation is best when it is a collaborate process. We encourage multiple people to take a look and provide feedback to make sure that it\u2019s the best that it can be. After this process is completed and the feature\/change is ready to go live, we merge the suggested edit!<\/p>\n<p>This workflow works great at our small size, and it scales really well to large teams where not everyone needs admin access. Most members of the team can just make changes through suggested edits, since most users don\u2019t need any of the functionality or control that full admin access provides. <\/p>\n<p>These changes have made a huge improvement to how we write documentation and we can\u2019t wait for everyone to try them out!<\/p>\n","protected":false},"excerpt":{"rendered":"<p>Recently, we released a brand new version of our Suggested Edits feature and as we were testing it internally, it dramatically changed how we approached writing documentation. It\u2019s allowed us to more easily collaborate on documentation and merge updates exactly when features go live. For all major changes to documentation (whether it be new features, [&hellip;]<\/p>\n","protected":false},"author":3,"featured_media":1230,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"content-type":"","inline_featured_image":false,"footnotes":""},"categories":[24],"tags":[],"ppma_author":[3],"class_list":["post-1240","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-readme-journey"],"acf":[],"yoast_head":"<!-- This site is optimized with the Yoast SEO plugin v23.0 - https:\/\/yoast.com\/wordpress\/plugins\/seo\/ -->\n<title>Workflow: Collaborative Documentation with Suggested Edits - ReadMe: Resource Library<\/title>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/readme.com\/resources\/workflow-collaborative-documentation-with-suggested-edits\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"Workflow: Collaborative Documentation with Suggested Edits - ReadMe: Resource Library\" \/>\n<meta property=\"og:description\" content=\"Recently, we released a brand new version of our Suggested Edits feature and as we were testing it internally, it dramatically changed how we approached writing documentation. It\u2019s allowed us to more easily collaborate on documentation and merge updates exactly when features go live. For all major changes to documentation (whether it be new features, [&hellip;]\" \/>\n<meta property=\"og:url\" content=\"https:\/\/readme.com\/resources\/workflow-collaborative-documentation-with-suggested-edits\" \/>\n<meta property=\"og:site_name\" content=\"ReadMe: Resource Library\" \/>\n<meta property=\"article:published_time\" content=\"2024-05-22T17:54:12+00:00\" \/>\n<meta property=\"article:modified_time\" content=\"2024-10-31T15:43:09+00:00\" \/>\n<meta property=\"og:image\" content=\"https:\/\/readme.com\/resources\/wp-content\/uploads\/2019\/02\/B0AE9A85-074A-4125-9393-58F887317631.png\" \/>\n\t<meta property=\"og:image:width\" content=\"7917\" \/>\n\t<meta property=\"og:image:height\" content=\"2500\" \/>\n\t<meta property=\"og:image:type\" content=\"image\/png\" \/>\n<meta name=\"author\" content=\"Sergey Bezdudnyy\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:label1\" content=\"Written by\" \/>\n\t<meta name=\"twitter:data1\" content=\"Sergey Bezdudnyy\" \/>\n\t<meta name=\"twitter:label2\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data2\" content=\"2 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"WebPage\",\"@id\":\"https:\/\/readme.com\/resources\/workflow-collaborative-documentation-with-suggested-edits\",\"url\":\"https:\/\/readme.com\/resources\/workflow-collaborative-documentation-with-suggested-edits\",\"name\":\"Workflow: Collaborative Documentation with Suggested Edits - ReadMe: Resource Library\",\"isPartOf\":{\"@id\":\"https:\/\/readme.com\/resources\/#website\"},\"primaryImageOfPage\":{\"@id\":\"https:\/\/readme.com\/resources\/workflow-collaborative-documentation-with-suggested-edits#primaryimage\"},\"image\":{\"@id\":\"https:\/\/readme.com\/resources\/workflow-collaborative-documentation-with-suggested-edits#primaryimage\"},\"thumbnailUrl\":\"https:\/\/readme.com\/resources\/wp-content\/uploads\/2019\/02\/B0AE9A85-074A-4125-9393-58F887317631.png\",\"datePublished\":\"2024-05-22T17:54:12+00:00\",\"dateModified\":\"2024-10-31T15:43:09+00:00\",\"author\":{\"@id\":\"https:\/\/readme.com\/resources\/#\/schema\/person\/5d27caf848984b250c70a69161b76828\"},\"breadcrumb\":{\"@id\":\"https:\/\/readme.com\/resources\/workflow-collaborative-documentation-with-suggested-edits#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/readme.com\/resources\/workflow-collaborative-documentation-with-suggested-edits\"]}]},{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/readme.com\/resources\/workflow-collaborative-documentation-with-suggested-edits#primaryimage\",\"url\":\"https:\/\/readme.com\/resources\/wp-content\/uploads\/2019\/02\/B0AE9A85-074A-4125-9393-58F887317631.png\",\"contentUrl\":\"https:\/\/readme.com\/resources\/wp-content\/uploads\/2019\/02\/B0AE9A85-074A-4125-9393-58F887317631.png\",\"width\":7917,\"height\":2500},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/readme.com\/resources\/workflow-collaborative-documentation-with-suggested-edits#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\/\/readme.com\/resources\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Workflow: Collaborative Documentation with Suggested Edits\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/readme.com\/resources\/#website\",\"url\":\"https:\/\/readme.com\/resources\/\",\"name\":\"ReadMe: Resource Library\",\"description\":\"Making API documentation better for everyone\",\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/readme.com\/resources\/?s={search_term_string}\"},\"query-input\":\"required name=search_term_string\"}],\"inLanguage\":\"en-US\"},{\"@type\":\"Person\",\"@id\":\"https:\/\/readme.com\/resources\/#\/schema\/person\/5d27caf848984b250c70a69161b76828\",\"name\":\"Sergey Bezdudnyy\",\"image\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/readme.com\/resources\/#\/schema\/person\/image\/8a01d0c296bdfcf8b54a6c0c0a94b904\",\"url\":\"https:\/\/readme.com\/resources\/wp-content\/uploads\/2024\/05\/sergey-profile-thumb.webp\",\"contentUrl\":\"https:\/\/readme.com\/resources\/wp-content\/uploads\/2024\/05\/sergey-profile-thumb.webp\",\"caption\":\"Sergey Bezdudnyy\"},\"sameAs\":[\"http:\/\/auq.io\"],\"url\":\"https:\/\/readme.com\/resources\/author\/sergey-auq\"}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"Workflow: Collaborative Documentation with Suggested Edits - ReadMe: Resource Library","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/readme.com\/resources\/workflow-collaborative-documentation-with-suggested-edits","og_locale":"en_US","og_type":"article","og_title":"Workflow: Collaborative Documentation with Suggested Edits - ReadMe: Resource Library","og_description":"Recently, we released a brand new version of our Suggested Edits feature and as we were testing it internally, it dramatically changed how we approached writing documentation. It\u2019s allowed us to more easily collaborate on documentation and merge updates exactly when features go live. For all major changes to documentation (whether it be new features, [&hellip;]","og_url":"https:\/\/readme.com\/resources\/workflow-collaborative-documentation-with-suggested-edits","og_site_name":"ReadMe: Resource Library","article_published_time":"2024-05-22T17:54:12+00:00","article_modified_time":"2024-10-31T15:43:09+00:00","og_image":[{"width":7917,"height":2500,"url":"https:\/\/readme.com\/resources\/wp-content\/uploads\/2019\/02\/B0AE9A85-074A-4125-9393-58F887317631.png","type":"image\/png"}],"author":"Sergey Bezdudnyy","twitter_card":"summary_large_image","twitter_misc":{"Written by":"Sergey Bezdudnyy","Est. reading time":"2 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/readme.com\/resources\/workflow-collaborative-documentation-with-suggested-edits","url":"https:\/\/readme.com\/resources\/workflow-collaborative-documentation-with-suggested-edits","name":"Workflow: Collaborative Documentation with Suggested Edits - ReadMe: Resource Library","isPartOf":{"@id":"https:\/\/readme.com\/resources\/#website"},"primaryImageOfPage":{"@id":"https:\/\/readme.com\/resources\/workflow-collaborative-documentation-with-suggested-edits#primaryimage"},"image":{"@id":"https:\/\/readme.com\/resources\/workflow-collaborative-documentation-with-suggested-edits#primaryimage"},"thumbnailUrl":"https:\/\/readme.com\/resources\/wp-content\/uploads\/2019\/02\/B0AE9A85-074A-4125-9393-58F887317631.png","datePublished":"2024-05-22T17:54:12+00:00","dateModified":"2024-10-31T15:43:09+00:00","author":{"@id":"https:\/\/readme.com\/resources\/#\/schema\/person\/5d27caf848984b250c70a69161b76828"},"breadcrumb":{"@id":"https:\/\/readme.com\/resources\/workflow-collaborative-documentation-with-suggested-edits#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/readme.com\/resources\/workflow-collaborative-documentation-with-suggested-edits"]}]},{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/readme.com\/resources\/workflow-collaborative-documentation-with-suggested-edits#primaryimage","url":"https:\/\/readme.com\/resources\/wp-content\/uploads\/2019\/02\/B0AE9A85-074A-4125-9393-58F887317631.png","contentUrl":"https:\/\/readme.com\/resources\/wp-content\/uploads\/2019\/02\/B0AE9A85-074A-4125-9393-58F887317631.png","width":7917,"height":2500},{"@type":"BreadcrumbList","@id":"https:\/\/readme.com\/resources\/workflow-collaborative-documentation-with-suggested-edits#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/readme.com\/resources\/"},{"@type":"ListItem","position":2,"name":"Workflow: Collaborative Documentation with Suggested Edits"}]},{"@type":"WebSite","@id":"https:\/\/readme.com\/resources\/#website","url":"https:\/\/readme.com\/resources\/","name":"ReadMe: Resource Library","description":"Making API documentation better for everyone","potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/readme.com\/resources\/?s={search_term_string}"},"query-input":"required name=search_term_string"}],"inLanguage":"en-US"},{"@type":"Person","@id":"https:\/\/readme.com\/resources\/#\/schema\/person\/5d27caf848984b250c70a69161b76828","name":"Sergey Bezdudnyy","image":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/readme.com\/resources\/#\/schema\/person\/image\/8a01d0c296bdfcf8b54a6c0c0a94b904","url":"https:\/\/readme.com\/resources\/wp-content\/uploads\/2024\/05\/sergey-profile-thumb.webp","contentUrl":"https:\/\/readme.com\/resources\/wp-content\/uploads\/2024\/05\/sergey-profile-thumb.webp","caption":"Sergey Bezdudnyy"},"sameAs":["http:\/\/auq.io"],"url":"https:\/\/readme.com\/resources\/author\/sergey-auq"}]}},"authors":[{"term_id":3,"user_id":3,"is_guest":0,"slug":"sergey-auq","display_name":"Sergey Bezdudnyy","avatar_url":{"url":"https:\/\/readme.com\/resources\/wp-content\/uploads\/2024\/05\/sergey-profile-thumb.webp","url2x":"https:\/\/readme.com\/resources\/wp-content\/uploads\/2024\/05\/sergey-profile-thumb.webp"},"first_name":"Sergey","last_name":"Bezdudnyy","position":"WordPress Developer","slogan":"Music \ud83c\udfb6\r\n\r\n<br>\r\n\r\nContent Marketing\r\n<br>\r\n&amp; More","description":"Today we\u2019ve got a special guest on the blog\u2014Ceci Stallsmith! If you were at API Mixtape 2023, you got to see her in action as a speaker. If you missed her talk, you\u2019re in luck, because today\u2019s post is covering the same topic: how to create developer marketing that doesn\u2019t suck.\r\n<br><br>\r\nToday we\u2019ve got a special guest on the blog\u2014Ceci Stallsmith! If you were at API Mixtape 2023, you got to see her in action as a speaker. If you missed her talk, you\u2019re in luck, because today\u2019s post is covering the same topic: how to create developer marketing that doesn\u2019t suck."}],"_links":{"self":[{"href":"https:\/\/readme.com\/resources\/wp-json\/wp\/v2\/posts\/1240","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/readme.com\/resources\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/readme.com\/resources\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/readme.com\/resources\/wp-json\/wp\/v2\/users\/3"}],"replies":[{"embeddable":true,"href":"https:\/\/readme.com\/resources\/wp-json\/wp\/v2\/comments?post=1240"}],"version-history":[{"count":0,"href":"https:\/\/readme.com\/resources\/wp-json\/wp\/v2\/posts\/1240\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/readme.com\/resources\/wp-json\/wp\/v2\/media\/1230"}],"wp:attachment":[{"href":"https:\/\/readme.com\/resources\/wp-json\/wp\/v2\/media?parent=1240"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/readme.com\/resources\/wp-json\/wp\/v2\/categories?post=1240"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/readme.com\/resources\/wp-json\/wp\/v2\/tags?post=1240"},{"taxonomy":"author","embeddable":true,"href":"https:\/\/readme.com\/resources\/wp-json\/wp\/v2\/ppma_author?post=1240"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}