{"id":335296,"date":"2023-08-04T16:28:16","date_gmt":"2023-08-04T08:28:16","guid":{"rendered":"https:\/\/www.idc.net\/help\/335296\/"},"modified":"2023-08-04T16:28:16","modified_gmt":"2023-08-04T08:28:16","slug":"%e8%bd%af%e4%bb%b6%e5%b7%a5%e7%a8%8b%e5%b8%88%e6%96%87%e6%a1%a3%e5%86%99%e4%bd%9c%e4%bc%98%e7%a7%80%e5%ae%9e%e8%b7%b5","status":"publish","type":"post","link":"https:\/\/idc.net\/help\/335296\/","title":{"rendered":"\u8f6f\u4ef6\u5de5\u7a0b\u5e08\u6587\u6863\u5199\u4f5c\u4f18\u79c0\u5b9e\u8df5"},"content":{"rendered":"<p style=\"text-align: center\"><img decoding=\"async\" src=\"https:\/\/s6.\/oss\/202204\/18\/050378e578c987a4df60310dc9c7fe799036d8.jpg\" style=\"width: 600px;height: 335px\" class=\"aligncenter\"><\/p>\n<p>\u4f5c\u4e3a\u8f6f\u4ef6\u5de5\u7a0b\u5e08\uff0c\u638c\u63e1\u7f16\u5199\u9ad8\u8d28\u91cf\u6587\u6863\u7684\u6280\u80fd\u975e\u5e38\u91cd\u8981\uff0c\u7279\u522b\u662f\u7531\u4e8e\u6700\u8fd1\u8fdc\u7a0b\u5de5\u4f5c\u7684\u589e\u52a0\uff0c\u5728\u5f02\u6b65\u901a\u4fe1\u65b9\u9762\u5c31\u9700\u8981\u505a\u5f97\u66f4\u597d\u3002\u4f5c\u4e3a\u8fdc\u7a0b\u5de5\u4f5c\u7684\u5b9e\u8df5\u8005\uff0cGitLab\u5728\u5b9a\u4e49\u5f02\u6b65\u6c9f\u901a<span>&nbsp;<\/span><span>[2]<\/span><span>&nbsp;<\/span>\u65b9\u9762\u505a\u5f97\u5f88\u597d\uff1a<\/p>\n<p>\u201c\u5f02\u6b65\u6c9f\u901a\u662f\u4e00\u79cd\u6c9f\u901a\u7684\u827a\u672f\uff0c\u65e0\u9700\u5728\u53d1\u9001\u516c\u5f00\u62a5\u544a\u7684\u540c\u65f6\u8ba9\u6240\u6709\u76f8\u5173\u65b9\u90fd\u5230\u573a\uff0c\u4e5f\u53ef\u4ee5\u63a8\u8fdb\u9879\u76ee\u5411\u524d\u3002\u201d<\/p>\n<p>\u9ad8\u8d28\u91cf\u7684\u6587\u6863\u662f\u5b9e\u73b0\u6709\u6548\u5f02\u6b65\u6c9f\u901a\u7684\u7b80\u5355\u65b9\u5f0f\u3002\u5728\u8fd9\u7bc7\u6587\u7ae0\u4e2d\uff0c\u6211\u5c06\u8ba8\u8bba\u4e00\u4e9b\u5728\u4e2a\u4eba\u7ecf\u5386\u4e2d\u975e\u5e38\u6709\u7528\u7684\u6709\u8da3\u7684\u6280\u5de7\u3002<\/p>\n<h4>\u8c37\u6b4c\u6280\u672f\u5199\u4f5c\u8bfe\u7a0b<\/h4>\n<p>\u8c37\u6b4c\u4e3a\u8f6f\u4ef6\u5de5\u7a0b\u5e08\u63d0\u4f9b\u4e86\u514d\u8d39\u7684\u6280\u672f\u5199\u4f5c\u8bfe\u7a0b\u3002\u8bfe\u7a0b\u4ece\u6280\u672f\u5199\u4f5c\u7684\u57fa\u7840\u90e8\u5206\u5f00\u59cb\uff0c\u5206\u4e3a\u4e24\u4e2a\u90e8\u5206\uff0c\u5185\u5bb9\u5982\u4e0b\uff1a<\/p>\n<p style=\"text-align: center\"><img decoding=\"async\" src=\"https:\/\/s5.\/oss\/202204\/18\/a12611b08d2ef80f5e1076c92382313292c858.jpg\" style=\"width: 488px;height: 694px\" class=\"aligncenter\"><\/p>\n<p style=\"text-align: center\">\u8c37\u6b4c\u6280\u672f\u5199\u4f5c1<\/p>\n<p style=\"text-align: center\"><img decoding=\"async\" src=\"https:\/\/s5.\/oss\/202204\/18\/a7742e352d47a7288838023a3595a0cca51b2d.jpg\" style=\"width: 528px;height: 350px\" class=\"aligncenter\"><\/p>\n<p style=\"text-align: center\">\u8c37\u6b4c\u6280\u672f\u5199\u4f5c2<\/p>\n<p>\u6ca1\u4eba\u80fd\u591f\u5728\u4e00\u591c\u4e4b\u95f4\u5c31\u64c5\u957f\u6280\u672f\u5199\u4f5c\uff0c\u8fd9\u9700\u8981\u53cd\u590d\u7ec3\u4e60\u3002\u6211\u4e2a\u4eba\u66f4\u559c\u6b22\u6bcf\u4e2a\u6708\u90fd\u53bb\u5b66\u4e60\u4e00\u4e0b\u8fd9\u95e8\u8bfe\u7a0b\uff0c\u4ee5\u63d0\u9192\u81ea\u5df1\u4ec0\u4e48\u624d\u662f\u5199\u4f5c\u7684\u6700\u4f73\u5b9e\u8df5\u3002<\/p>\n<h4>\u4f7f\u7528Divio\u6587\u6863\u6846\u67b6<\/h4>\n<p>\u5728\u6240\u6709\u6587\u6863\u6846\u67b6\u4e2d\uff0c\u6211\u4e2a\u4eba\u6700\u559c\u6b22Divio<span>&nbsp;<\/span><span>[3]<\/span><span>&nbsp;<\/span>\u3002\u8fd9\u91cc\u5efa\u8bae\u7684\u6587\u6863\u7cfb\u7edf\u975e\u5e38\u7b80\u5355\u5e76\u4e14\u666e\u904d\u9002\u7528\u3002<\/p>\n<p>\u8be5\u6846\u67b6\u5efa\u8bae\u5c06\u6587\u6863\u5206\u7c7b\u5982\u4e0b\uff1a<\/p>\n<ul>\n<li>\u6559\u7a0b\uff08Tutorials\uff09\u2014\u2014 \u9762\u5411\u5b66\u4e60\u7684<\/li>\n<li>\u6307\u5357\uff08How-To Guides\uff09\u2014\u2014 \u9762\u5411\u95ee\u9898\u89e3\u51b3\u7684<\/li>\n<li>\u89e3\u91ca\uff08Explanation\uff09\u2014\u2014 \u9762\u5411\u7406\u89e3\u7684<\/li>\n<li>\u7d22\u5f15\uff08Reference\uff09\u2014\u2014 \u9762\u5411\u4fe1\u606f\u7684<\/li>\n<\/ul>\n<p>\u8be5\u65b9\u6848\u88ab\u8bb8\u591a\u8457\u540d\u5f00\u6e90\u9879\u76ee\u548c\u4f01\u4e1a\u5e7f\u6cdb\u91c7\u7528<span>&nbsp;<\/span><span>[4]<\/span><span>&nbsp;<\/span>\u3002<\/p>\n<p>youtube\u4e0a\u6709\u4e00\u4e2a\u5f88\u597d\u7684\u89c6\u9891\uff0c\u8be6\u7ec6\u89e3\u91ca\u4e86\u6846\u67b6\u7684\u7ec6\u8282\uff1ahttps:\/\/youtu.be\/t4vKPhjcMZg<\/p>\n<h4>\u4f7f\u7528\u57fa\u4e8emarkdown\u7684\u6587\u6863\u7cfb\u7edf<\/h4>\n<p>\u5728\u4f20\u7edf\u4f01\u4e1a\u4e2d\uff0c\u53ef\u4ee5\u4f7f\u7528\u5404\u79cd\u65b9\u6cd5\u6765\u7ef4\u62a4\u6587\u6863\u3002\u6709\u4e9b\u4eba\u559c\u6b22\u521b\u5efaMS Word\/Excel\u6587\u6863\uff0c\u7136\u540e\u4e0a\u4f20\u5230SharePoint\u6216OneDrives\u4e2d\u3002\u6b64\u7c7b\u6587\u6863\u6700\u5927\u95ee\u9898\u662f\uff0c\u65e0\u6cd5\u4f7f\u7528\u5185\u90e8\u641c\u7d22\u5f15\u64ce\u8fdb\u884c\u641c\u7d22\u3002\u56e0\u6b64\uff0c\u6211\u4e2a\u4eba\u66f4\u559c\u6b22\u4f7f\u7528\u57fa\u4e8emarkdown\u7684\u6587\u6863\u7cfb\u7edf\u3002\u521b\u5efa\u548c\u7ef4\u62a4\u8fd9\u7c7b\u6587\u6863\u5f88\u5bb9\u6613\uff0c\u5e76\u4e14\u6587\u6863\u662f\u53ef\u641c\u7d22\u7684\u3002<\/p>\n<p>\u5982\u679c\u4f60\u8fd8\u4e0d\u719f\u6089Markdown\uff0c\u53ef\u4ee5\u67e5\u770bGitHub\u4e0a\u7684\u514d\u8d39\u8bfe\u7a0b<span>&nbsp;<\/span><span>[5]<\/span><span>&nbsp;<\/span>\uff0c\u8f7b\u677e\u638c\u63e1\u8fd9\u4e2a\u5de5\u5177\u3002<\/p>\n<h4>\u4f7f\u7528Mermaid JS\u4f5c\u56fe<\/h4>\n<p>\u6839\u636eMermaid<span>&nbsp;<\/span><span>[6]<\/span><span>&nbsp;<\/span>\u7684\u8bf4\u6cd5\uff0c\u8fd9\u662f\u201c\u4e00\u4e2a\u57fa\u4e8ejavascript\u7684\u56fe\u5f62\u548c\u56fe\u8868\u5de5\u5177\uff0c\u4f7f\u7528\u7c7b\u4f3cmarkdown\u7684\u6587\u672c\u5b9a\u4e49\u548c\u6e32\u67d3\u5668\u6765\u521b\u5efa\u548c\u4fee\u6539\u590d\u6742\u7684\u56fe\u8868\u3002\u201d\u5982\u679c\u4f7f\u7528GitLab\u6216Azure DevOps\uff0c\u539f\u751f\u5c31\u652f\u6301\u4e86Mermaid\uff0c\u5982\u679c\u4f7f\u7528GitHub\u6216Atlassian\u7684\u4ea7\u54c1\uff0c\u90a3\u4e48\u53ef\u4ee5\u901a\u8fc7\u63d2\u4ef6\u4f7f\u7528\u3002<\/p>\n<p>\u4f7f\u7528Mermaid\u521b\u5efa\u548c\u66f4\u65b0\u56fe\u8868\u975e\u5e38\u5bb9\u6613\uff0c\u4e0d\u9700\u8981\u7ed9\u6bcf\u4e2a\u5f00\u53d1\u4eba\u5458\u5b89\u88c5Visio\/draw.io\u8fd9\u6837\u7684UML\u5de5\u5177\u3002<\/p>\n<p>\u4e0b\u9762\u662f\u4e00\u4e9b\u7528Mermaid\u521b\u5efa\u7684\u793a\u4f8b\u56fe\uff1a<\/p>\n<p style=\"text-align: center\"><img decoding=\"async\" src=\"https:\/\/s8.\/oss\/202204\/18\/91b062d87eefe0105316526701744a1abb5f1e.jpg\" style=\"width: 550px;height: 267px\" class=\"aligncenter\"><\/p>\n<p style=\"text-align: center\">Mermaid\u5e8f\u5217\u56fe\u793a\u4f8b<\/p>\n<p style=\"text-align: center\"><img decoding=\"async\" src=\"https:\/\/s9.\/oss\/202204\/18\/c90dc74543cd067f5da6750412c3eac283a268.jpg\" style=\"width: 550px;height: 260px\" class=\"aligncenter\"><\/p>\n<p style=\"text-align: center\">Mermaid\u7c7b\u56fe\u793a\u4f8b<\/p>\n<p>\u53ef\u4ee5\u7acb\u5373\u5c1d\u8bd5\u4f7f\u7528Mermaid Live Editor<span>&nbsp;<\/span><span>[7]<\/span><span>&nbsp;<\/span>\u521b\u5efa\u56fe\u8868\u3002<\/p>\n<h4>\u4f7f\u7528\u6a21\u677f<\/h4>\n<p>\u50cfConfluence\u8fd9\u6837\u7684\u7f51\u7ad9\u4e0a\u6709\u5f88\u591a\u6a21\u677f\uff0c\u53ef\u4ee5\u7528\u4e8e\u7279\u5b9a\u7c7b\u578b\u7684\u6587\u6863\u3002\u4f8b\u5982\uff1a<\/p>\n<ul>\n<li>\u8f6f\u4ef6\u67b6\u6784\u8bc4\u5ba1\u6a21\u677f\uff08Software Architecture Review Template\uff09<span>&nbsp;<\/span><span>[8]<\/span><\/li>\n<li>\u67b6\u6784\u51b3\u7b56\u8bb0\u5f55\u6a21\u677f\uff08Architecture Decision Record Template\uff09<span>&nbsp;<\/span><span>[9]<\/span><\/li>\n<li>\u4e8b\u6545\u5206\u6790\u6a21\u677f\uff08Incident Postmortem Template\uff09<span>&nbsp;<\/span><span>[10]<\/span><\/li>\n<li>DevOps\u6267\u884c\u624b\u518c\uff08DevOps Runbook\uff09<span>&nbsp;<\/span><span>[11]<\/span><\/li>\n<li>\u51b3\u7b56\u6a21\u677f\uff08Decision Template\uff09<span>&nbsp;<\/span><span>[12]<\/span><\/li>\n<li>\u5199\u4f5c\u6307\u5357\uff08Writing Guidelines\uff09<span>&nbsp;<\/span><span>[13]<\/span><\/li>\n<li>OKR\u6a21\u677f\uff08OKR Template\uff09<span>&nbsp;<\/span><span>[14]<\/span><\/li>\n<li>\u7b49\u7b49<\/li>\n<\/ul>\n<h4>\u53c2\u8003\u98ce\u683c\u6307\u5357\uff08Style Guides\uff09<\/h4>\n<p>\u5982\u679c\u4f60\u7684\u56e2\u961f\u8fd8\u6ca1\u6709\u98ce\u683c\u6307\u5357\uff0c\u53ef\u4ee5\u53c2\u8003\u4e00\u4e0b\u8c37\u6b4c\u548c\u5fae\u8f6f\u7684\u505a\u6cd5\uff1a<\/p>\n<ul>\n<li>Microsoft Style Guide<span>&nbsp;<\/span><span>[15]<\/span><\/li>\n<li>Google Developer Documentation Style Guide<span>&nbsp;<\/span><span>[16]<\/span><\/li>\n<\/ul>\n<pre><span style=\"margin: 0px;padding: 0px\">References<\/span>: [<span style=\"margin: 0px;padding: 0px\">1<\/span>] <span style=\"margin: 0px;padding: 0px\">Best<\/span> <span style=\"margin: 0px;padding: 0px\">Practices<\/span> <span style=\"margin: 0px;padding: 0px\">When<\/span> <span style=\"margin: 0px;padding: 0px\">Documenting<\/span> <span style=\"margin: 0px;padding: 0px\">Your<\/span> <span style=\"margin: 0px;padding: 0px\">Code<\/span> <span style=\"margin: 0px;padding: 0px\">for<\/span> <span style=\"margin: 0px;padding: 0px\">Software<\/span> <span style=\"margin: 0px;padding: 0px\">Engineers<\/span>:&nbsp;<span style=\"margin: 0px;padding: 0px\">https<\/span>:<span style=\"margin: 0px;padding: 0px\">\/\/betterprogramming.pub\/best-practices-when-documenting-your-code-for-software-engineers-941f0897aa0 [2] How to embrace asynchronous communication for remote work:&nbsp;https:\/\/about.gitlab.com\/company\/culture\/all-remote\/asynchronous\/ [3] Divio:&nbsp;https:\/\/www.divio.com\/ [4] Who is using the system:&nbsp;https:\/\/documentation.divio.com\/adoption\/#adoption [5] Mastering Markdown:&nbsp;https:\/\/guides.github.com\/features\/mastering-markdown\/ [6] Mermaid:&nbsp;http:\/\/mermaid-js.github.io\/mermaid\/ [7] Mermaid Live Editor:&nbsp;https:\/\/mermaid-js.github.io\/mermaid-live-editor\/ [8] Software Architecture Review Template:&nbsp;https:\/\/www.atlassian.com\/software\/confluence\/templates\/software-architecture-review [9] Lightweight Architecture Decision Records:&nbsp;https:\/\/github.com\/deshpandetanmay\/lightweight-architecture-decision-records\/blob\/master\/doc\/adr\/0001-use-elasticsearch-for-search-api.md [10] Incident Postmortem:&nbsp;https:\/\/www.atlassian.com\/software\/confluence\/templates\/incident-postmortem [11] DevOps Runbook:&nbsp;https:\/\/www.atlassian.com\/software\/confluence\/templates\/devops-runbook [12] Decision Template:&nbsp;https:\/\/www.atlassian.com\/software\/confluence\/templates\/decision [13] Writing Guidelines:&nbsp;https:\/\/www.atlassian.com\/software\/confluence\/templates\/writing-guidelines [14] OKR Template:&nbsp;https:\/\/www.atlassian.com\/software\/confluence\/templates\/okrs [15] Microsoft Style Guide:&nbsp;https:\/\/docs.microsoft.com\/en-us\/style-guide\/ [16] Google Developer Documentation Style Guide:&nbsp;https:\/\/developers.google.com\/style<\/span><br><\/pre>\n<p>\u4f60\u597d\uff0c\u6211\u662f\u4fde\u51e1\uff0c\u5728Motorola\u505a\u8fc7\u7814\u53d1\uff0c\u73b0\u5728\u5728Mavenir\u505a\u6280\u672f\u5de5\u4f5c\uff0c\u5bf9\u901a\u4fe1\u3001\u7f51\u7edc\u3001\u540e\u7aef\u67b6\u6784\u3001\u4e91\u539f\u751f\u3001DevOps\u3001CICD\u3001\u533a\u5757\u94fe\u3001AI\u7b49\u6280\u672f\u59cb\u7ec8\u4fdd\u6301\u7740\u6d53\u539a\u7684\u5174\u8da3\uff0c\u5e73\u65f6\u559c\u6b22\u9605\u8bfb\u3001\u601d\u8003\uff0c\u76f8\u4fe1\u6301\u7eed\u5b66\u4e60\u3001\u7ec8\u8eab\u6210\u957f\uff0c\u6b22\u8fce\u4e00\u8d77\u4ea4\u6d41\u5b66\u4e60\u3002<\/p>\n","protected":false},"excerpt":{"rendered":"<p>\u4f5c\u4e3a\u8f6f\u4ef6\u5de5\u7a0b\u5e08\uff0c\u638c\u63e1\u7f16\u5199\u9ad8\u8d28\u91cf\u6587\u6863\u7684\u6280\u80fd\u975e\u5e38\u91cd\u8981\uff0c\u7279\u522b\u662f\u7531\u4e8e\u6700\u8fd1\u8fdc\u7a0b\u5de5\u4f5c\u7684\u589e\u52a0\uff0c\u5728\u5f02\u6b65\u901a\u4fe1\u65b9\u9762\u5c31\u9700\u8981\u505a\u5f97\u66f4\u597d\u3002 [&hellip;]<\/p>\n","protected":false},"author":1,"featured_media":335297,"comment_status":"closed","ping_status":"","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[61],"tags":[],"class_list":["post-335296","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-website"],"_links":{"self":[{"href":"https:\/\/idc.net\/help\/wp-json\/wp\/v2\/posts\/335296","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/idc.net\/help\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/idc.net\/help\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/idc.net\/help\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/idc.net\/help\/wp-json\/wp\/v2\/comments?post=335296"}],"version-history":[{"count":0,"href":"https:\/\/idc.net\/help\/wp-json\/wp\/v2\/posts\/335296\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/idc.net\/help\/wp-json\/wp\/v2\/media\/335297"}],"wp:attachment":[{"href":"https:\/\/idc.net\/help\/wp-json\/wp\/v2\/media?parent=335296"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/idc.net\/help\/wp-json\/wp\/v2\/categories?post=335296"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/idc.net\/help\/wp-json\/wp\/v2\/tags?post=335296"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}