{"id":511794,"date":"2024-09-19T14:30:51","date_gmt":"2024-09-19T13:30:51","guid":{"rendered":"https:\/\/blog.jetbrains.com\/?post_type=writerside&#038;p=511794"},"modified":"2024-10-15T19:34:03","modified_gmt":"2024-10-15T18:34:03","slug":"new-in-writerside-the-good-docs-project-templates-right-in-your-editor","status":"publish","type":"writerside","link":"https:\/\/blog.jetbrains.com\/zh-hans\/writerside\/2024\/09\/new-in-writerside-the-good-docs-project-templates-right-in-your-editor","title":{"rendered":"New in Writerside: The Good Docs Project Templates Right in Your Editor"},"content":{"rendered":"\n<figure class=\"wp-block-image size-full\"><img decoding=\"async\" loading=\"lazy\" width=\"1280\" height=\"720\" src=\"https:\/\/blog.jetbrains.com\/wp-content\/uploads\/2024\/09\/Blog-Featured-1280x720-1-1.png\" alt=\"\" class=\"wp-image-511796\"\/><\/figure>\n\n\n\n<p>\u201cI hate to write, but I love having written,\u201d a famous saying goes. Don\u2019t we all \u2013 especially those of us who write functional texts, like technical documentation? We often have too little time to even convey the basic idea, let alone categorize and structure the information \u2013 whether it\u2019s a how-to guide, a reference, or a quickstart tutorial.<\/p>\n\n\n\n<p>That\u2019s why Writerside now includes a rich library of open-source documentation templates from <a href=\"https:\/\/www.thegooddocsproject.dev\" target=\"_blank\" rel=\"noreferrer noopener\">The Good Docs Project<\/a>. From \u201cAPI Reference\u201d to \u201cRelease Notes\u201d, templates are just one click away.<\/p>\n\n\n    <div class=\"buttons\">\n        <div class=\"buttons__row\">\n                                                <a href=\"https:\/\/jetbrains.com\/writerside\/download\" class=\"btn\" target=\"_blank\" rel=\"noopener\">Download Writerside<\/a>\n                                                    <\/div>\n    <\/div>\n\n\n\n\n\n\n\n<h1 class=\"wp-block-heading\">Documentation templates: when and why<\/h1>\n\n\n\n<p>As much fun as it may be to picture ourselves as writers with a quill and blank paper, our work environment rarely allows for this in reality. Usually, we are stressed, rushed, and looking for shortcuts. Templates can be a game-changer in this context.&nbsp;<\/p>\n\n\n\n<p><strong>For small teams with just one writer (or none at all)<\/strong>,<strong> <\/strong>templates offer significant advantages:<\/p>\n\n\n\n<ul>\n<li><strong>Speed up the process<\/strong>: Fill in the blanks and publish.<\/li>\n\n\n\n<li><strong>Facilitate contributions<\/strong>: Teammates can easily fill in details in a pre-formatted structure.<\/li>\n<\/ul>\n\n\n\n<p><br><strong>For mid-sized and larger teams<\/strong>, templates provide additional practical benefits:<\/p>\n\n\n\n<ul>\n<li><strong>Maintain consistency<\/strong> across all documentation.<\/li>\n\n\n\n<li><strong>Reduce the need for micro-management<\/strong> by replacing it with standardization.<\/li>\n<\/ul>\n\n\n\n<p><\/p>\n\n\n\n<p>That is all good and well. But where do you find effective documentation templates?<\/p>\n\n\n\n<h1 class=\"wp-block-heading\">Enter The Good Docs Project<\/h1>\n\n\n\n<p>The Good Docs Project is a global community committed to improving the quality of software documentation, both in the open-source world and beyond. Technical writers, software engineers, and UX specialists from all over the world have been collaborating to create the first <a href=\"https:\/\/www.thegooddocsproject.dev\/template\" target=\"_blank\" rel=\"noreferrer noopener\">open, best-practices suite of writing templates.<\/a><\/p>\n\n\n\n<p>This is where Writerside finds its perfect match. While our tool initially offered a basic set of documentation templates, we&#8217;re now adding the <strong>full library from The Good Docs Project<\/strong>. These templates cover all types of documentation and come with instructions on how to use them, making it easier to quickly craft any type of doc with Writerside.&nbsp;<\/p>\n\n\n\n<h1 class=\"wp-block-heading\">How to use documentation templates in Writerside<\/h1>\n\n\n\n<p>The Good Docs Project\u2019s templates are written in Markdown, making it easy to adapt them for any project. They are also completely free and open to everyone, encouraging collaboration and accessibility.<\/p>\n\n\n\n<p>And starting with the <a href=\"https:\/\/jetbrains.com\/writerside\/download\" data-type=\"link\" data-id=\"https:\/\/jetbrains.com\/writerside\/download\" target=\"_blank\" rel=\"noopener\">EAP 8 release<\/a>, they are all available in Writerside.&nbsp;<\/p>\n\n\n\n<p>You don\u2019t need to be a documentation expert to use them. Open the template library, browse through the list, preview the templates, and add them to your project with the click of a button:<\/p>\n\n\n\n<figure class=\"wp-block-image size-full\"><img decoding=\"async\" loading=\"lazy\" width=\"1920\" height=\"1080\" src=\"https:\/\/blog.jetbrains.com\/wp-content\/uploads\/2024\/09\/template_library3.gif\" alt=\"\" class=\"wp-image-511810\"\/><\/figure>\n\n\n\n<p>And of course, you can also <a href=\"https:\/\/www.jetbrains.com\/help\/writerside\/save-as-template.html\" target=\"_blank\" rel=\"noreferrer noopener\">create unique templates<\/a> for your project. Such custom templates can be brand new, based on an existing content file, or adapted from one of the built-in templates provided in Writerside.<\/p>\n\n\n\n<h1 class=\"wp-block-heading\">Help us improve<\/h1>\n\n\n\n<p>In collaboration with The Good Docs Project, Writerside is on a mission to help everyone create better docs. We\u2019d love to hear your thoughts:<\/p>\n\n\n\n<p><strong>Feedback on the templates<\/strong>: There\u2019s a feedback link at the end of each template. Please use it to share how you used the template, what worked well, and what could be improved.<\/p>\n\n\n\n<p><strong>Your Writerside experience<\/strong>: Did everything work as expected? Was it easy to find and use the templates? Let us know!<\/p>\n\n\n\n<p><\/p>\n\n\n    <div class=\"buttons\">\n        <div class=\"buttons__row\">\n                                                <a href=\"https:\/\/www.jetbrains.com\/help\/writerside\/whats-new-last-update.html\" class=\"btn btn--transparent\" target=\"_blank\" rel=\"noopener\">See the full list of new features<\/a>\n                                                                <a href=\"https:\/\/jetbrains.com\/writerside\/download\" class=\"btn \" target=\"_blank\" rel=\"noopener\">? Download Writerside ?<\/a>\n                                    <\/div>\n    <\/div>\n\n\n\n\n\n\n\n<p>Have ideas or suggestions? Bring them to <a href=\"https:\/\/jb.gg\/WRS_Slack\" target=\"_blank\" rel=\"noreferrer noopener\">our Slack community<\/a>! ?<\/p>\n","protected":false},"author":343,"featured_media":511796,"comment_status":"closed","ping_status":"closed","template":"","categories":[],"tags":[657,600,76],"cross-post-tag":[],"acf":[],"_links":{"self":[{"href":"https:\/\/blog.jetbrains.com\/zh-hans\/wp-json\/wp\/v2\/writerside\/511794"}],"collection":[{"href":"https:\/\/blog.jetbrains.com\/zh-hans\/wp-json\/wp\/v2\/writerside"}],"about":[{"href":"https:\/\/blog.jetbrains.com\/zh-hans\/wp-json\/wp\/v2\/types\/writerside"}],"author":[{"embeddable":true,"href":"https:\/\/blog.jetbrains.com\/zh-hans\/wp-json\/wp\/v2\/users\/343"}],"replies":[{"embeddable":true,"href":"https:\/\/blog.jetbrains.com\/zh-hans\/wp-json\/wp\/v2\/comments?post=511794"}],"version-history":[{"count":10,"href":"https:\/\/blog.jetbrains.com\/zh-hans\/wp-json\/wp\/v2\/writerside\/511794\/revisions"}],"predecessor-version":[{"id":511930,"href":"https:\/\/blog.jetbrains.com\/zh-hans\/wp-json\/wp\/v2\/writerside\/511794\/revisions\/511930"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/blog.jetbrains.com\/zh-hans\/wp-json\/wp\/v2\/media\/511796"}],"wp:attachment":[{"href":"https:\/\/blog.jetbrains.com\/zh-hans\/wp-json\/wp\/v2\/media?parent=511794"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/blog.jetbrains.com\/zh-hans\/wp-json\/wp\/v2\/categories?post=511794"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/blog.jetbrains.com\/zh-hans\/wp-json\/wp\/v2\/tags?post=511794"},{"taxonomy":"cross-post-tag","embeddable":true,"href":"https:\/\/blog.jetbrains.com\/zh-hans\/wp-json\/wp\/v2\/cross-post-tag?post=511794"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}