136 lines
460 KiB
HTML
136 lines
460 KiB
HTML
|
<!DOCTYPE html>
|
|||
|
|
<html><head><title>简介</title><meta charSet="utf-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta property="og:title" content="简介"/><meta property="og:description" content="本指南旨在规范中文技术文档的写作，提高可读性，统一风格，降低沟通成本。."/><meta property="og:image" content="https://wiki.7wate.com/static/og-image.png"/><meta property="og:width" content="1200"/><meta property="og:height" content="675"/><link rel="icon" href="../../../static/icon.png"/><meta name="description" content="本指南旨在规范中文技术文档的写作，提高可读性，统一风格，降低沟通成本。."/><meta name="generator" content="Quartz"/><link rel="preconnect" href="https://fonts.googleapis.com"/><link rel="preconnect" href="https://fonts.gstatic.com"/><script async src="https://umami.7wate.com/script.js" data-website-id="c061efdc-95dd-4d21-9d04-a1ffda0a85b9"></script><script>
|
|||
|
|
var _hmt = _hmt || [];
|
|||
|
|
(function() {
|
|||
|
|
var hm = document.createElement("script");
|
|||
|
|
hm.src = "https://hm.baidu.com/hm.js?94d8ccb156eb7c65abf317e6e01cdba9";
|
|||
|
|
var s = document.getElementsByTagName("script")[0];
|
|||
|
|
s.parentNode.insertBefore(hm, s);
|
|||
|
|
})();
|
|||
|
|
</script><script async src="https://www.googletagmanager.com/gtag/js?id=G-MHMEL0F832"></script><script>
|
|||
|
|
(function() {
|
|||
|
|
window.dataLayer = window.dataLayer || [];
|
|||
|
|
function gtag() {
|
|||
|
|
window.dataLayer.push(arguments);
|
|||
|
|
}
|
|||
|
|
gtag('js', new Date());
|
|||
|
|
gtag('config', 'G-MHMEL0F832');
|
|||
|
|
})();
|
|||
|
|
</script><link href="../../../index.css" rel="stylesheet" type="text/css" spa-preserve/><link href="https://cdn.jsdelivr.net/npm/katex@0.16.0/dist/katex.min.css" rel="stylesheet" type="text/css" spa-preserve/><link href="https://fonts.googleapis.com/css2?family=IBM Plex Mono&family=Schibsted Grotesk:wght@400;700&family=Source Sans Pro:ital,wght@0,400;0,600;1,400;1,600&display=swap" rel="stylesheet" type="text/css" spa-preserve/><script src="../../../prescript.js" type="application/javascript" spa-preserve></script><script type="application/javascript" spa-preserve>const fetchData = fetch(`../../../static/contentIndex.json`).then(data => data.json())</script></head><body data-slug="Technology/SoftwareEngineering/技术文档/1.简介"><div id="quartz-root" class="page"><div id="quartz-body"><div class="left sidebar"><h1 class="page-title "><a href="../../..">📚 X·Eden</a></h1><div class="spacer mobile-only"></div><div class="search "><div id="search-icon"><p>Search</p><div></div><svg tabIndex="0" aria-labelledby="title desc" role="img" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 19.9 19.7"><title id="title">Search</title><desc id="desc">Search</desc><g class="search-path" fill="none"><path stroke-linecap="square" d="M18.5 18.3l-5.4-5.4"></path><circle cx="8" cy="8" r="7"></circle></g></svg></div><div id="search-container"><div id="search-space"><input autocomplete="off" id="search-bar" name="search" type="text" aria-label="Search for something" placeholder="Search for something"/><div id="results-container"></div></div></div></div><div class="darkmode "><input class="toggle" id="darkmode-toggle" type="checkbox" tabIndex="-1"/><label id="toggle-label-light" for="darkmode-toggle" tabIndex="-1"><svg xmlns="http://www.w3.org/2000/svg" xmlnsXlink="http://www.w3.org/1999/xlink" version="1.1" id="dayIcon" x="0px" y="0px" viewBox="0 0 35 35" style="enable-background:new 0 0 35 35;" xmlSpace="preserve"><title>Light mode</title><path d="M6,17.5C6,16.672,5.328,16,4.5,16h-3C0.672,16,0,16.672,0,17.5 S0.672,19,1.5,19h3C5.328,19,6,18.328,6,17.5z M7.5,26c-0.414,0-0.789,0.168-1.061,0.439l-2,2C4.168,28.711,4,29.086,4,29.5 C4,30.328,4.671,31,5.5,31c0.414,0,0.789-0.168,1.06-0.44l2-2C8.832,28.289,9,27.914,9,27.5C9,26.672,8.329,26,7.5,26z M17.5,6 C18.329,6,19,5.328,19,4.5v-3C19,0.672,18.329,0,17.5,0S16,0.672,16,1.5v3C16,5.328,16.671,6,17.5,6z M27.5,9 c0.414,0,0.789-0.168,1.06-0.439l2-2C30.832,6.289,31,5.914,31,5.5C31,4.672,30.329,4,29.5,4c-0.414,0-0.789,0.168-1.061,0.44 l-2,2C26.168,6.711,26,7.086,26,7.5C26,8.328,26.671,9,27.5,9z M6.439,8.561C6.711,8.832,7.086,9,7.5,9C8.328,9,9,8.328,9,7.5 c0-0.414-0.168-0.789-0.439-1.061l-2-2C6.289,4.168,5.914,4,5.5,4C4.672,4,4,4.672,4,5.5c0,0.414,0.168,0.789,0.439,1.06 L6.439,8.561z M33.5,16h-3c-0.828,0-1.5,0.672-1.5,1.5s0.672,1.5,1.5,1.5h3c0.828,0,1.5-0.672,1.5-1.5S34.328,16,33.5,16z M28.561,26.439C28.289,26.168,27.914,26,27.5,26c-0.828,0-1.5,0.672-1.5,1.5c0,0.414,0.168,0.789,0.439,1.06l2,2 C28.711,30.832,29.086,31,29.5,31c0.828,0,1.5-0.672,1.5-1.5c0-0.414-0.168-0.789-0.439-1.061L28.561,26.439z M17.5,29 c-0.829,0-1.5,0.672-1.5,1.5v3c0,0.828,0.671,1.5,1.5,1.5s1.5-0.672,1.5-1.5v-3C19,29.672,18.329,29,17.5,29z M17.5,7 C11.71,7,7,11.71,7,17.5S11.71,28,17.5,28S28,23.29,28,17.5S23.29,7,17.5,7z M17.5,25c-4.136,0-7.5-3.364-7.5-7.5 c0-4.136,3.364-7.5,7.5-7.5c4.136,0,7.5,3.364,7.5,7.5C25,21.636,21.636,25,17.5,25z"></path></svg></label><label id="toggle-label-dark" for="darkmode-toggle" tabIndex="-1"><svg xmlns="http://www.w3.org/2000/svg" xmlnsXlink="http://www.w3.org/1999/xlink" version="1.1" id="nightIcon" x="0px" y="0px" viewBox="0 0 100 100" style="enable-background='new 0 0 100 100'" xmlSpace="preserve"><title>Dark mode</title><path d="M96.76,66.458c-0.853-0.852-2.15-1.064-3.23-0.534c-6.063,2.991-12.858,4.571-19.655,4.571 C62.022,70.495,50.88,65.88,42.5,57.5C29.043,44.043,25.658,23.536,34.076,6.47c0.532-1.08,0.318-2.379-0.534-3.23 c-0.851-0.852-2.15-1.064-3.23-0.534c-4.918,2.427-9.375,5.619-13.246,9.491c-9.447,9.447-14.65,22.008-14.65,35.369 c0,
|
|||
|
|
<p>本指南规范了一种中文写作风格，主要用于技术文档的编写。素材来源于互联网，为各家中文文案风格指南的综合，旨在对中文技术文档的<strong>语言风格、结构样式、内容元素、标点符号、格式排版</strong>等方面给出参考规范。我希望本指南的出现能为日后业界标准的建立贡献一点力量。</p>
|
|||
|
|
<h2 id="目的">目的<a aria-hidden="true" tabindex="-1" href="#目的" class="internal"> §</a></h2>
|
|||
|
|
<ul>
|
|||
|
|
<li>提高中文文案的可读性。</li>
|
|||
|
|
<li>统一文档风格，保证组织对外输出形象一致。</li>
|
|||
|
|
<li>避免不同的文档作者对同一问题反复作出决策，降低与文档相关的沟通成本。</li>
|
|||
|
|
</ul>
|
|||
|
|
<h2 id="适用范围">适用范围<a aria-hidden="true" tabindex="-1" href="#适用范围" class="internal"> §</a></h2>
|
|||
|
|
<ul>
|
|||
|
|
<li>为编写中文文档的作者（如产品研发人员、技术写作人员等）提供规范或建议。</li>
|
|||
|
|
<li>审校文档过程中争议问题的裁决。</li>
|
|||
|
|
<li>也可供软件界面、帮助文档等资料开发人员参考。</li>
|
|||
|
|
</ul>
|
|||
|
|
<h2 id="目录大纲">目录大纲<a aria-hidden="true" tabindex="-1" href="#目录大纲" class="internal"> §</a></h2>
|
|||
|
|
<h3 id="简介"><a href="../../../Tech/software-engineering/技术文档/1.简介" class="internal" data-slug="Tech/software-engineering/技术文档/1.简介">简介</a><a aria-hidden="true" tabindex="-1" href="#简介" class="internal"> §</a></h3>
|
|||
|
|
<ul>
|
|||
|
|
<li>技术文档的重要性</li>
|
|||
|
|
<li>技术文档的类型</li>
|
|||
|
|
</ul>
|
|||
|
|
<h3 id="标点符号"><a href="../../../Tech/software-engineering/技术文档/2.标点符号" class="internal" data-slug="Tech/software-engineering/技术文档/2.标点符号">标点符号</a><a aria-hidden="true" tabindex="-1" href="#标点符号" class="internal"> §</a></h3>
|
|||
|
|
<ul>
|
|||
|
|
<li>标点符号的基本规则</li>
|
|||
|
|
<li>常见的错误用法</li>
|
|||
|
|
</ul>
|
|||
|
|
<h3 id="命名约定"><a href="../../../Tech/software-engineering/技术文档/3.命名约定" class="internal" data-slug="Tech/software-engineering/技术文档/3.命名约定">命名约定</a><a aria-hidden="true" tabindex="-1" href="#命名约定" class="internal"> §</a></h3>
|
|||
|
|
<ul>
|
|||
|
|
<li>命名约定的重要性</li>
|
|||
|
|
<li>常见的命名规则</li>
|
|||
|
|
</ul>
|
|||
|
|
<h3 id="语言风格"><a href="../../../Tech/software-engineering/技术文档/4.语言风格" class="internal" data-slug="Tech/software-engineering/技术文档/4.语言风格">语言风格</a><a aria-hidden="true" tabindex="-1" href="#语言风格" class="internal"> §</a></h3>
|
|||
|
|
<ul>
|
|||
|
|
<li>语言风格的定义</li>
|
|||
|
|
<li>一致性和简洁性的重要性</li>
|
|||
|
|
</ul>
|
|||
|
|
<h3 id="文档内容"><a href="../../../Tech/software-engineering/技术文档/5.文档内容" class="internal" data-slug="Tech/software-engineering/技术文档/5.文档内容">文档内容</a><a aria-hidden="true" tabindex="-1" href="#文档内容" class="internal"> §</a></h3>
|
|||
|
|
<ul>
|
|||
|
|
<li>文档内容的构成</li>
|
|||
|
|
<li>如何编写高质量的文档内容</li>
|
|||
|
|
</ul>
|
|||
|
|
<h3 id="文档结构"><a href="../../../Tech/software-engineering/技术文档/6.文档结构" class="internal" data-slug="Tech/software-engineering/技术文档/6.文档结构">文档结构</a><a aria-hidden="true" tabindex="-1" href="#文档结构" class="internal"> §</a></h3>
|
|||
|
|
<ul>
|
|||
|
|
<li>文档的基本结构</li>
|
|||
|
|
<li>不同类型文档的结构差异</li>
|
|||
|
|
</ul>
|
|||
|
|
<h3 id="附录资料"><a href="../../../Tech/software-engineering/技术文档/7.附录资料" class="internal" data-slug="Tech/software-engineering/技术文档/7.附录资料">附录资料</a><a aria-hidden="true" tabindex="-1" href="#附录资料" class="internal"> §</a></h3>
|
|||
|
|
<ul>
|
|||
|
|
<li>附录的定义</li>
|
|||
|
|
<li>附录的使用场景</li>
|
|||
|
|
</ul>
|
|||
|
|
<h2 id="使用原则">使用原则<a aria-hidden="true" tabindex="-1" href="#使用原则" class="internal"> §</a></h2>
|
|||
|
|
<p>本指南是一本查询手册，建议初次阅读本指南时，先大致浏览目录章节结构，了解本指南涵盖的内容范围；之后就编写文档时碰到的实际问题，再回头查找相应规范。</p>
|
|||
|
|
<h2 id="修订和审查">修订和审查<a aria-hidden="true" tabindex="-1" href="#修订和审查" class="internal"> §</a></h2>
|
|||
|
|
<ol>
|
|||
|
|
<li><strong>定期修订</strong>：定期修订文档，以保持其准确性和时效性。</li>
|
|||
|
|
<li><strong>多人审查</strong>：邀请其他人审查文档，他们可能会发现你可能忽视的错误或者遗漏。</li>
|
|||
|
|
</ol>
|
|||
|
|
<p>本指南主要针对中文技术文档的编写给出了一系列的规范和建议，包括语言风格、结构样式、内容元素、标点符号、格式排版等方面。我希望本指南能帮助你提高中文文档的编写质量，提高其可读性，同时也能减少与文档相关的沟通成本。</p></article></div><div class="right sidebar"><div class="graph "><h3>Graph View</h3><div class="graph-outer"><div id="graph-container" data-cfg="{"drag":true,"zoom":true,"depth":1,"scale":1.1,"repelForce":0.5,"centerForce":0.3,"linkDistance":30,"fontSize":0.6,"opacityScale":1,"showTags":true,"removeTags":[]}"></div><svg version="1.1" id="global-graph-icon" xmlns="http://www.w3.org/2000/svg" xmlnsXlink="http://www.w3.org/1999/xlink" x="0px" y="0px" viewBox="0 0 55 55" fill="currentColor" xmlSpace="preserve"><path d="M49,0c-3.309,0-6,2.691-6,6c0,1.035,0.263,2.009,0.726,2.86l-9.829,9.829C32.542,17.634,30.846,17,29,17
|
|||
|
|
s-3.542,0.634-4.898,1.688l-7.669-7.669C16.785,10.424,17,9.74,17,9c0-2.206-1.794-4-4-4S9,6.794,9,9s1.794,4,4,4
|
|||
|
|
c0.74,0,1.424-0.215,2.019-0.567l7.669,7.669C21.634,21.458,21,23.154,21,25s0.634,3.542,1.688,4.897L10.024,42.562
|
|||
|
|
C8.958,41.595,7.549,41,6,41c-3.309,0-6,2.691-6,6s2.691,6,6,6s6-2.691,6-6c0-1.035-0.263-2.009-0.726-2.86l12.829-12.829
|
|||
|
|
c1.106,0.86,2.44,1.436,3.898,1.619v10.16c-2.833,0.478-5,2.942-5,5.91c0,3.309,2.691,6,6,6s6-2.691,6-6c0-2.967-2.167-5.431-5-5.91
|
|||
|
|
v-10.16c1.458-0.183,2.792-0.759,3.898-1.619l7.669,7.669C41.215,39.576,41,40.26,41,41c0,2.206,1.794,4,4,4s4-1.794,4-4
|
|||
|
|
s-1.794-4-4-4c-0.74,0-1.424,0.215-2.019,0.567l-7.669-7.669C36.366,28.542,37,26.846,37,25s-0.634-3.542-1.688-4.897l9.665-9.665
|
|||
|
|
C46.042,11.405,47.451,12,49,12c3.309,0,6-2.691,6-6S52.309,0,49,0z M11,9c0-1.103,0.897-2,2-2s2,0.897,2,2s-0.897,2-2,2
|
|||
|
|
S11,10.103,11,9z M6,51c-2.206,0-4-1.794-4-4s1.794-4,4-4s4,1.794,4,4S8.206,51,6,51z M33,49c0,2.206-1.794,4-4,4s-4-1.794-4-4
|
|||
|
|
s1.794-4,4-4S33,46.794,33,49z M29,31c-3.309,0-6-2.691-6-6s2.691-6,6-6s6,2.691,6,6S32.309,31,29,31z M47,41c0,1.103-0.897,2-2,2
|
|||
|
|
s-2-0.897-2-2s0.897-2,2-2S47,39.897,47,41z M49,10c-2.206,0-4-1.794-4-4s1.794-4,4-4s4,1.794,4,4S51.206,10,49,10z"></path></svg></div><div id="global-graph-outer"><div id="global-graph-container" data-cfg="{"drag":true,"zoom":true,"depth":-1,"scale":0.9,"repelForce":0.5,"centerForce":0.3,"linkDistance":30,"fontSize":0.6,"opacityScale":1,"showTags":true,"removeTags":[]}"></div></div></div><div class="toc desktop-only"><button type="button" id="toc" class><h3>Table of Contents</h3><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="fold"><polyline points="6 9 12 15 18 9"></polyline></svg></button><div id="toc-content"><ul class="overflow"><li class="depth-0"><a href="#引言" data-for="引言">引言</a></li><li class="depth-0"><a href="#目的" data-for="目的">目的</a></li><li class="depth-0"><a href="#适用范围" data-for="适用范围">适用范围</a></li><li class="depth-0"><a href="#目录大纲" data-for="目录大纲">目录大纲</a></li><li class="depth-1"><a href="#简介" data-for="简介">简介</a></li><li class="depth-1"><a href="#标点符号" data-for="标点符号">标点符号</a></li><li class="depth-1"><a href="#命名约定" data-for="命名约定">命名约定</a></li><li class="depth-1"><a href="#语言风格" data-for="语言风格">语言风格</a></li><li class="depth-1"><a href="#文档内容" data-for="文档内容">文档内容</a></li><li class="depth-1"><a href="#文档结构" data-for="文档结构">文档结构</a></li><li class="depth-1"><a href="#附录资料" data-for="附录资料">附录资料</a></li><li class="depth-0"><a href="#使用原则" data-for="使用原则">使用原则</a></li><li class="depth-0"><a href="#修订和审查" data-for="修订和审查">修订和审查</a></li></ul></div></div><div class="backlinks "><h3>Backlinks</h3><ul class="overflow"><li>No backlinks found</li></ul></div><div class="explorer mobile-only"><button type="button" id="explorer" data-behavior="collapse" data-collapsed="collapsed" data-savestate="true" data-tree="[{"path":"Journal","collapsed":true},{"path":"Journal/2024","collapsed":true},{"path":"Journal/2024/W33","collapsed":true},{"path":"Obsidian","collapsed":true},{"path":"Obsidian/Templates","collapsed":true},{"path":"Personal","collapsed":true},{"path":"Personal/Blog","collapsed":true},{"path":"Personal/Blog/2018","collapsed":true},{"path":"Personal/Blog/2020","collapsed":true},{"path":"Personal/Blog/2021","collapsed":true},{"path":"Personal/Blog/2022","collapsed":true},{"path":"Personal/Blog/2023","collapsed":true},{"path":"Personal/Blog/2024","collapsed":true},{"path":"Personal/Book","collapsed":true},{"path":"Personal/Book/个人成长","collapsed":true},{"path":"Personal/Book/医学健康","collapsed":true},{"path":"Personal/Book/历史","collapsed":true},{"path":"Personal/Book/哲学宗教","collapsed":true},{"path":"Personal/Book/心理","collapsed":true},{"path":"Personal/Book/政治军事","collapsed":true},{"path":"Personal/Book/教育学习","collapsed":true},{"path":"Personal/Book/文学","collapsed":true},{"path":"Personal/Book/生活百科","collapsed":true},{"path":"Personal/Book/社<><E7A4BE>
|
|||
|
|
function toggleCallout() {
|
|||
|
|
const outerBlock = this.parentElement;
|
|||
|
|
outerBlock.classList.toggle(`is-collapsed`);
|
|||
|
|
const collapsed = outerBlock.classList.contains(`is-collapsed`);
|
|||
|
|
const height = collapsed ? this.scrollHeight : outerBlock.scrollHeight;
|
|||
|
|
outerBlock.style.maxHeight = height + `px`;
|
|||
|
|
let current = outerBlock;
|
|||
|
|
let parent = outerBlock.parentElement;
|
|||
|
|
while (parent) {
|
|||
|
|
if (!parent.classList.contains(`callout`)) {
|
|||
|
|
return;
|
|||
|
|
}
|
|||
|
|
const collapsed2 = parent.classList.contains(`is-collapsed`);
|
|||
|
|
const height2 = collapsed2 ? parent.scrollHeight : parent.scrollHeight + current.scrollHeight;
|
|||
|
|
parent.style.maxHeight = height2 + `px`;
|
|||
|
|
current = parent;
|
|||
|
|
parent = parent.parentElement;
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
function setupCallout() {
|
|||
|
|
const collapsible = document.getElementsByClassName(
|
|||
|
|
`callout is-collapsible`
|
|||
|
|
);
|
|||
|
|
for (const div of collapsible) {
|
|||
|
|
const title = div.firstElementChild;
|
|||
|
|
if (title) {
|
|||
|
|
title.removeEventListener(`click`, toggleCallout);
|
|||
|
|
title.addEventListener(`click`, toggleCallout);
|
|||
|
|
const collapsed = div.classList.contains(`is-collapsed`);
|
|||
|
|
const height = collapsed ? title.scrollHeight : div.scrollHeight;
|
|||
|
|
div.style.maxHeight = height + `px`;
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
document.addEventListener(`nav`, setupCallout);
|
|||
|
|
window.addEventListener(`resize`, setupCallout);
|
|||
|
|
</script><script type="module">
|
|||
|
|
import mermaid from 'https://cdn.jsdelivr.net/npm/mermaid/dist/mermaid.esm.min.mjs';
|
|||
|
|
const darkMode = document.documentElement.getAttribute('saved-theme') === 'dark'
|
|||
|
|
mermaid.initialize({
|
|||
|
|
startOnLoad: false,
|
|||
|
|
securityLevel: 'loose',
|
|||
|
|
theme: darkMode ? 'dark' : 'default'
|
|||
|
|
});
|
|||
|
|
document.addEventListener('nav', async () => {
|
|||
|
|
await mermaid.run({
|
|||
|
|
querySelector: '.mermaid'
|
|||
|
|
})
|
|||
|
|
});
|
|||
|
|
</script><script src="https://cdn.jsdelivr.net/npm/katex@0.16.7/dist/contrib/copy-tex.min.js" type="application/javascript"></script><script src="../../../postscript.js" type="module"></script></html>
|