CINXE.COM

<!doctype html><html lang="en-US" prefix="og: https://ogp.me/ns#"><head><meta charSet="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1"/><link rel="icon" href="https://developer.mozilla.org/favicon-48x48.bc390275e955dacb2e65.png"/><link rel="apple-touch-icon" href="https://developer.mozilla.org/apple-touch-icon.528534bba673c38049c2.png"/><meta name="theme-color" content="#ffffff"/><link rel="manifest" href="https://developer.mozilla.org/manifest.f42880861b394dd4dc9b.json"/><link rel="search" type="application/opensearchdescription+xml" href="/opensearch.xml" title="MDN Web Docs"/><title>撰写指南 - MDN Web 文档项目 | MDN</title><link rel="alternate" title="Schreibrichtlinien" href="https://developer.mozilla.org/de/docs/MDN/Writing_guidelines" hrefLang="de"/><link rel="alternate" title="Writing guidelines" href="https://developer.mozilla.org/en-US/docs/MDN/Writing_guidelines" hrefLang="en"/><link rel="alternate" title="Guías de escritura" href="https://developer.mozilla.org/es/docs/MDN/Writing_guidelines" hrefLang="es"/><link rel="alternate" title="Règles d'écriture" href="https://developer.mozilla.org/fr/docs/MDN/Writing_guidelines" hrefLang="fr"/><link rel="alternate" title="執筆ガイドライン" href="https://developer.mozilla.org/ja/docs/MDN/Writing_guidelines" hrefLang="ja"/><link rel="alternate" title="쓰기 안내서" href="https://developer.mozilla.org/ko/docs/MDN/Writing_guidelines" hrefLang="ko"/><link rel="alternate" title="Sobre o MDN" href="https://developer.mozilla.org/pt-BR/docs/MDN/Writing_guidelines" hrefLang="pt"/><link rel="alternate" title="Руководства по составлению документации" href="https://developer.mozilla.org/ru/docs/MDN/Writing_guidelines" hrefLang="ru"/><link rel="alternate" title="關於 MDN" href="https://developer.mozilla.org/zh-TW/docs/MDN/Writing_guidelines" hrefLang="zh-Hant"/><link rel="alternate" title="撰写指南" href="https://developer.mozilla.org/zh-CN/docs/MDN/Writing_guidelines" hrefLang="zh"/><link rel="preload" as="font" type="font/woff2" href="/static/media/Inter.var.c2fe3cb2b7c746f7966a.woff2" crossorigin=""/><link rel="alternate" type="application/rss+xml" title="MDN Blog RSS Feed" href="https://developer.mozilla.org/en-US/blog/rss.xml" hrefLang="en"/><meta name="description" content="MDN Web 文档是一个开源项目。下面的概述部分描述了有关我们在 MDN Web 文档上撰写什么文档以及如何撰写文档的指南。学习如何做出贡献，请参见我们的贡献指南。"/><meta property="og:url" content="https://developer.mozilla.org/zh-CN/docs/MDN/Writing_guidelines"/><meta property="og:title" content="撰写指南 - MDN Web 文档项目 | MDN"/><meta property="og:type" content="website"/><meta property="og:locale" content="zh_CN"/><meta property="og:description" content="MDN Web 文档是一个开源项目。下面的概述部分描述了有关我们在 MDN Web 文档上撰写什么文档以及如何撰写文档的指南。学习如何做出贡献，请参见我们的贡献指南。"/><meta property="og:image" content="https://developer.mozilla.org/mdn-social-share.d893525a4fb5fb1f67a2.png"/><meta property="og:image:type" content="image/png"/><meta property="og:image:height" content="1080"/><meta property="og:image:width" content="1920"/><meta property="og:image:alt" content="The MDN Web Docs logo, featuring a blue accent color, displayed on a solid black background."/><meta property="og:site_name" content="MDN Web Docs"/><meta name="twitter:card" content="summary_large_image"/><meta name="twitter:creator" content="MozDevNet"/><link rel="canonical" href="https://developer.mozilla.org/zh-CN/docs/MDN/Writing_guidelines"/><style media="print">.article-actions-container,.document-toc-container,.language-menu,.main-menu-toggle,.on-github,.page-footer,.place,.sidebar,.top-banner,.top-navigation-main,ul.prev-next{display:none!important}.main-page-content,.main-page-content pre{padding:2px}.main-page-content pre{border-left-width:2px}</style><script src="/static/js/gtag.js" defer=""></script><script defer="" src="/static/js/main.5e889624.js"></script><link href="/static/css/main.26c64ea7.css" rel="stylesheet"/></head><body><script>if(document.body.addEventListener("load",(t=>{t.target.classList.contains("interactive")&&t.target.setAttribute("data-readystate","complete")}),{capture:!0}),window&&document.documentElement){const t={light:"#ffffff",dark:"#1b1b1b"};try{const e=window.localStorage.getItem("theme");e&&(document.documentElement.className=e,document.documentElement.style.backgroundColor=t[e]);const o=window.localStorage.getItem("nop");o&&(document.documentElement.dataset.nop=o)}catch(t){console.warn("Unable to read theme from localStorage",t)}}</script><div id="root"><ul id="nav-access" class="a11y-nav"><li><a id="skip-main" href="#content">Skip to main content</a></li><li><a id="skip-search" href="#top-nav-search-input">Skip to search</a></li><li><a id="skip-select-language" href="#languages-switcher-button">Skip to select language</a></li></ul><div class="page-wrapper document-page"><div class="top-banner loading"><section class="place top container"></section></div><div class="sticky-header-container"><header class="top-navigation "><div class="container "><div class="top-navigation-wrap"><a href="/zh-CN/" class="logo" aria-label="MDN homepage"><svg id="mdn-docs-logo" xmlns="http://www.w3.org/2000/svg" x="0" y="0" viewBox="0 0 694.9 104.4" style="enable-background:new 0 0 694.9 104.4" xml:space="preserve" role="img"><title>MDN Web Docs</title><path d="M40.3 0 11.7 92.1H0L28.5 0h11.8zm10.4 0v92.1H40.3V0h10.4zM91 0 62.5 92.1H50.8L79.3 0H91zm10.4 0v92.1H91V0h10.4z" class="logo-m"></path><path d="M627.9 95.6h67v8.8h-67v-8.8z" class="logo-_"></path><path d="M367 42h-4l-10.7 30.8h-5.5l-10.8-26h-.4l-10.5 26h-5.2L308.7 42h-3.8v-5.6H323V42h-6.5l6.8 20.4h.4l10.3-26h4.7l11.2 26h.5l5.7-20.3h-6.2v-5.6H367V42zm34.9 20c-.4 3.2-2 5.9-4.7 8.2-2.8 2.3-6.5 3.4-11.3 3.4-5.4 0-9.7-1.6-13.1-4.7-3.3-3.2-5-7.7-5-13.7 0-5.7 1.6-10.3 4.7-14s7.4-5.5 12.9-5.5c5.1 0 9.1 1.6 11.9 4.7s4.3 6.9 4.3 11.3c0 1.5-.2 3-.5 4.7h-25.6c.3 7.7 4 11.6 10.9 11.6 2.9 0 5.1-.7 6.5-2 1.5-1.4 2.5-3 3-4.9l6 .9zM394 51.3c.2-2.4-.4-4.7-1.8-6.9s-3.8-3.3-7-3.3c-3.1 0-5.3 1-6.9 3-1.5 2-2.5 4.4-2.8 7.2H394zm51 2.4c0 5-1.3 9.5-4 13.7s-6.9 6.2-12.7 6.2c-6 0-10.3-2.2-12.7-6.7-.1.4-.2 1.4-.4 2.9s-.3 2.5-.4 2.9h-7.3c.3-1.7.6-3.5.8-5.3.3-1.8.4-3.7.4-5.5V22.3h-6v-5.6H416v27c1.1-2.2 2.7-4.1 4.7-5.7 2-1.6 4.8-2.4 8.4-2.4 4.6 0 8.4 1.6 11.4 4.7 3 3.2 4.5 7.6 4.5 13.4zm-7.7.6c0-4.2-1-7.4-3-9.5-2-2.2-4.4-3.3-7.4-3.3-3.4 0-6 1.2-8 3.7-1.9 2.4-2.9 5-3 7.7V57c0 3 1 5.6 3 7.7s4.5 3.1 7.6 3.1c3.6 0 6.3-1.3 8.1-3.9 1.8-2.7 2.7-5.9 2.7-9.6zm69.2 18.5h-13.2v-7.2c-1.2 2.2-2.8 4.1-4.9 5.6-2.1 1.6-4.8 2.4-8.3 2.4-4.8 0-8.7-1.6-11.6-4.9-2.9-3.2-4.3-7.7-4.3-13.3 0-5 1.3-9.6 4-13.7 2.6-4.1 6.9-6.2 12.8-6.2 5.7 0 9.8 2.2 12.3 6.5V22.3h-8.6v-5.6h15.8v50.6h6v5.5zM493.2 56v-4.4c-.1-3-1.2-5.5-3.2-7.3s-4.4-2.8-7.2-2.8c-3.6 0-6.3 1.3-8.2 3.9-1.9 2.6-2.8 5.8-2.8 9.6 0 4.1 1 7.3 3 9.5s4.5 3.3 7.4 3.3c3.2 0 5.8-1.3 7.8-3.8 2.1-2.6 3.1-5.3 3.2-8zm53.1-1.4c0 5.6-1.8 10.2-5.3 13.7s-8.2 5.3-13.9 5.3-10.1-1.7-13.4-5.1c-3.3-3.4-5-7.9-5-13.5 0-5.3 1.6-9.9 4.7-13.7 3.2-3.8 7.9-5.7 14.2-5.7s11 1.9 14.1 5.7c3 3.7 4.6 8.1 4.6 13.3zm-7.7-.2c0-4-1-7.2-3-9.5s-4.8-3.5-8.2-3.5c-3.6 0-6.4 1.2-8.3 3.7s-2.9 5.6-2.9 9.5c0 3.7.9 6.8 2.8 9.4 1.9 2.6 4.6 3.9 8.3 3.9 3.6 0 6.4-1.3 8.4-3.8 1.9-2.6 2.9-5.8 2.9-9.7zm45 5.8c-.4 3.2-1.9 6.3-4.4 9.1-2.5 2.9-6.4 4.3-11.8 4.3-5.2 0-9.4-1.6-12.6-4.8-3.2-3.2-4.8-7.7-4.8-13.7 0-5.5 1.6-10.1 4.7-13.9 3.2-3.8 7.6-5.7 13.2-5.7 2.3 0 4.6.3 6.7.8 2.2.5 4.2 1.5 6.2 2.9l1.5 9.5-5.9.7-1.3-6.1c-2.1-1.2-4.5-1.8-7.2-1.8-3.5 0-6.1 1.2-7.7 3.7-1.7 2.5-2.5 5.7-2.5 9.6 0 4.1.9 7.3 2.7 9.5 1.8 2.3 4.4 3.4 7.8 3.4 5.2 0 8.2-2.9 9.2-8.8l6.2 1.3zm34.7 1.9c0 3.6-1.5 6.5-4.6 8.5s-7 3-11.7 3c-5.7 0-10.6-1.2-14.6-3.6l1.2-8.8 5.7.6-.2 4.7c1.1.5 2.3.9 3.6 1.1s2.6.3 3.9.3c2.4 0 4.5-.4 6.5-1.3 1.9-.9 2.9-2.2 2.9-4.1 0-1.8-.8-3.1-2.3-3.8s-3.5-1.3-5.8-1.7-4.6-.9-6.9-1.4c-2.3-.6-4.2-1.6-5.7-2.9-1.6-1.4-2.3-3.5-2.3-6.3 0-4.1 1.5-6.9 4.6-8.5s6.4-2.4 9.9-2.4c2.6 0 5 .3 7.2.9 2.2.6 4.3 1.4 6.1 2.4l.8 8.8-5.8.7-.8-5.7c-2.3-1-4.7-1.6-7.2-1.6-2.1 0-3.7.4-5.1 1.1-1.3.8-2 2-2 3.8 0 1.7.8 2.9 2.3 3.6 1.5.7 3.4 1.2 5.7 1.6 2.2.4 4.5.8 6.7 1.4 2.2.6 4.1 1.6 5.7 3 1.4 1.6 2.2 3.7 2.2 6.6zM197.6 73.2h-17.1v-5.5h3.8V51.9c0-3.7-.7-6.3-2.1-7.9-1.4-1.6-3.3-2.3-5.7-2.3-3.2 0-5.6 1.1-7.2 3.4s-2.4 4.6-2.5 6.9v15.6h6v5.5h-17.1v-5.5h3.8V51.9c0-3.8-.7-6.4-2.1-7.9-1.4-1.5-3.3-2.3-5.6-2.3-3.2 0-5.5 1.1-7.2 3.3-1.6 2.2-2.4 4.5-2.5 6.9v15.8h6.9v5.5h-20.2v-5.5h6V42.4h-6.1v-5.6h13.4v6.4c1.2-2.1 2.7-3.8 4.7-5.2 2-1.3 4.4-2 7.3-2s5.3.7 7.5 2.1c2.2 1.4 3.7 3.5 4.5 6.4 1.1-2.5 2.7-4.5 4.9-6.1s4.8-2.4 7.9-2.4c3.5 0 6.5 1.1 8.9 3.3s3.7 5.6 3.7 10.2v18.2h6.1v5.5zm42.5 0h-13.2V66c-1.2 2.2-2.8 4.1-4.9 5.6-2.1 1.6-4.8 2.4-8.3 2.4-4.8 0-8.7-1.6-11.6-4.9-2.9-3.2-4.3-7.7-4.3-13.3 0-5 1.3-9.6 4-13.7 2.6-4.1 6.9-6.2 12.8-6.2s9.8 2.2 12.3 6.5V22.7h-8.6v-5.6h15.8v50.6h6v5.5zm-13.3-16.8V52c-.1-3-1.2-5.5-3.2-7.3s-4.4-2.8-7.2-2.8c-3.6 0-6.3 1.3-8.2 3.9-1.9 2.6-2.8 5.8-2.8 9.6 0 4.1 1 7.3 3 9.5s4.5 3.3 7.4 3.3c3.2 0 5.8-1.3 7.8-3.8 2.1-2.6 3.1-5.3 3.2-8zm61.5 16.8H269v-5.5h6V51.9c0-3.7-.7-6.3-2.2-7.9-1.4-1.6-3.4-2.3-5.7-2.3-3.1 0-5.6 1-7.4 3s-2.8 4.4-2.9 7v15.9h6v5.5h-19.3v-5.5h6V42.4h-6.2v-5.6h13.6V43c2.6-4.6 6.8-6.9 12.7-6.9 3.6 0 6.7 1.1 9.2 3.3s3.7 5.6 3.7 10.2v18.2h6v5.4h-.2z" class="logo-text"></path></svg></a><button title="Open main menu" type="button" class="button action has-icon main-menu-toggle" aria-haspopup="menu" aria-label="Open main menu" aria-expanded="false"><span class="button-wrap"><span class="icon icon-menu "></span><span class="visually-hidden">Open main menu</span></span></button></div><div class="top-navigation-main"><nav class="main-nav" aria-label="Main menu"><ul class="main-menu nojs"><li class="top-level-entry-container "><button type="button" id="references-button" class="top-level-entry menu-toggle" aria-controls="references-menu" aria-expanded="false">References</button><a href="/zh-CN/docs/Web" class="top-level-entry">References</a><ul id="references-menu" class="submenu references hidden inline-submenu-lg" aria-labelledby="references-button"><li class="apis-link-container mobile-only "><a href="/zh-CN/docs/Web" class="submenu-item "><div class="submenu-icon"></div><div class="submenu-content-container"><div class="submenu-item-heading">Overview / Web Technology</div><p class="submenu-item-description">Web technology reference for developers</p></div></a></li><li class="html-link-container "><a href="/zh-CN/docs/Web/HTML" class="submenu-item "><div class="submenu-icon html"></div><div class="submenu-content-container"><div class="submenu-item-heading">HTML</div><p class="submenu-item-description">Structure of content on the web</p></div></a></li><li class="css-link-container "><a href="/zh-CN/docs/Web/CSS" class="submenu-item "><div class="submenu-icon css"></div><div class="submenu-content-container"><div class="submenu-item-heading">CSS</div><p class="submenu-item-description">Code used to describe document style</p></div></a></li><li class="javascript-link-container "><a href="/zh-CN/docs/Web/JavaScript" class="submenu-item "><div class="submenu-icon javascript"></div><div class="submenu-content-container"><div class="submenu-item-heading">JavaScript</div><p class="submenu-item-description">General-purpose scripting language</p></div></a></li><li class="http-link-container "><a href="/zh-CN/docs/Web/HTTP" class="submenu-item "><div class="submenu-icon http"></div><div class="submenu-content-container"><div class="submenu-item-heading">HTTP</div><p class="submenu-item-description">Protocol for transmitting web resources</p></div></a></li><li class="apis-link-container "><a href="/zh-CN/docs/Web/API" class="submenu-item "><div class="submenu-icon apis"></div><div class="submenu-content-container"><div class="submenu-item-heading">Web APIs</div><p class="submenu-item-description">Interfaces for building web applications</p></div></a></li><li class="apis-link-container "><a href="/zh-CN/docs/Mozilla/Add-ons/WebExtensions" class="submenu-item "><div class="submenu-icon"></div><div class="submenu-content-container"><div class="submenu-item-heading">Web Extensions</div><p class="submenu-item-description">Developing extensions for web browsers</p></div></a></li><li class="apis-link-container desktop-only "><a href="/zh-CN/docs/Web" class="submenu-item "><div class="submenu-icon"></div><div class="submenu-content-container"><div class="submenu-item-heading">Web Technology</div><p class="submenu-item-description">Web technology reference for developers</p></div></a></li></ul></li><li class="top-level-entry-container "><button type="button" id="guides-button" class="top-level-entry menu-toggle" aria-controls="guides-menu" aria-expanded="false">Guides</button><a href="/zh-CN/docs/Learn" class="top-level-entry">Guides</a><ul id="guides-menu" class="submenu guides hidden inline-submenu-lg" aria-labelledby="guides-button"><li class="apis-link-container mobile-only "><a href="/zh-CN/docs/Learn" class="submenu-item "><div class="submenu-icon learn"></div><div class="submenu-content-container"><div class="submenu-item-heading">Overview / MDN Learning Area</div><p class="submenu-item-description">Learn web development</p></div></a></li><li class="apis-link-container desktop-only "><a href="/zh-CN/docs/Learn" class="submenu-item "><div class="submenu-icon learn"></div><div class="submenu-content-container"><div class="submenu-item-heading">MDN Learning Area</div><p class="submenu-item-description">Learn web development</p></div></a></li><li class="html-link-container "><a href="/zh-CN/docs/Learn/HTML" class="submenu-item "><div class="submenu-icon html"></div><div class="submenu-content-container"><div class="submenu-item-heading">HTML</div><p class="submenu-item-description">Learn to structure web content with HTML</p></div></a></li><li class="css-link-container "><a href="/zh-CN/docs/Learn/CSS" class="submenu-item "><div class="submenu-icon css"></div><div class="submenu-content-container"><div class="submenu-item-heading">CSS</div><p class="submenu-item-description">Learn to style content using CSS</p></div></a></li><li class="javascript-link-container "><a href="/zh-CN/docs/Learn/JavaScript" class="submenu-item "><div class="submenu-icon javascript"></div><div class="submenu-content-container"><div class="submenu-item-heading">JavaScript</div><p class="submenu-item-description">Learn to run scripts in the browser</p></div></a></li><li class=" "><a href="/zh-CN/docs/Web/Accessibility" class="submenu-item "><div class="submenu-icon"></div><div class="submenu-content-container"><div class="submenu-item-heading">Accessibility</div><p class="submenu-item-description">Learn to make the web accessible to all</p></div></a></li></ul></li><li class="top-level-entry-container "><button type="button" id="mdn-plus-button" class="top-level-entry menu-toggle" aria-controls="mdn-plus-menu" aria-expanded="false">Plus</button><a href="/zh-CN/plus" class="top-level-entry">Plus</a><ul id="mdn-plus-menu" class="submenu mdn-plus hidden inline-submenu-lg" aria-labelledby="mdn-plus-button"><li class=" "><a href="/zh-CN/plus" class="submenu-item "><div class="submenu-icon"></div><div class="submenu-content-container"><div class="submenu-item-heading">Overview</div><p class="submenu-item-description">A customized MDN experience</p></div></a></li><li class=" "><a href="/zh-CN/plus/ai-help" class="submenu-item "><div class="submenu-icon"></div><div class="submenu-content-container"><div class="submenu-item-heading">AI Help</div><p class="submenu-item-description">Get real-time assistance and support</p></div></a></li><li class=" "><a href="/zh-CN/plus/updates" class="submenu-item "><div class="submenu-icon"></div><div class="submenu-content-container"><div class="submenu-item-heading">Updates</div><p class="submenu-item-description">All browser compatibility updates at a glance</p></div></a></li><li class=" "><a href="/en-US/plus/docs/features/overview" class="submenu-item "><div class="submenu-icon"></div><div class="submenu-content-container"><div class="submenu-item-heading">Documentation</div><p class="submenu-item-description">Learn how to use MDN Plus</p></div></a></li><li class=" "><a href="/en-US/plus/docs/faq" class="submenu-item "><div class="submenu-icon"></div><div class="submenu-content-container"><div class="submenu-item-heading">FAQ</div><p class="submenu-item-description">Frequently asked questions about MDN Plus</p></div></a></li></ul></li><li class="top-level-entry-container "><a class="top-level-entry menu-link" href="/en-US/curriculum/">Curriculum <sup class="new">New</sup></a></li><li class="top-level-entry-container "><a class="top-level-entry menu-link" href="/en-US/blog/">Blog</a></li><li class="top-level-entry-container "><button type="button" id="tools-button" class="top-level-entry menu-toggle" aria-controls="tools-menu" aria-expanded="false">Tools</button><ul id="tools-menu" class="submenu tools hidden inline-submenu-lg" aria-labelledby="tools-button"><li class=" "><a href="/zh-CN/play" class="submenu-item "><div class="submenu-icon"></div><div class="submenu-content-container"><div class="submenu-item-heading">Playground</div><p class="submenu-item-description">Write, test and share your code</p></div></a></li><li class=" "><a href="/en-US/observatory" class="submenu-item "><div class="submenu-icon"></div><div class="submenu-content-container"><div class="submenu-item-heading">HTTP Observatory</div><p class="submenu-item-description">Scan a website for free</p></div></a></li><li class=" "><a href="/en-US/plus/ai-help" class="submenu-item "><div class="submenu-icon"></div><div class="submenu-content-container"><div class="submenu-item-heading">AI Help</div><p class="submenu-item-description">Get real-time assistance and support</p></div></a></li></ul></li></ul></nav><div class="header-search"><form action="/zh-CN/search" class="search-form search-widget" id="top-nav-search-form" role="search"><label id="top-nav-search-label" for="top-nav-search-input" class="visually-hidden">Search MDN</label><input aria-activedescendant="" aria-autocomplete="list" aria-controls="top-nav-search-menu" aria-expanded="false" aria-labelledby="top-nav-search-label" autoComplete="off" id="top-nav-search-input" role="combobox" type="search" class="search-input-field" name="q" placeholder=" " required="" value=""/><button type="button" class="button action has-icon clear-search-button"><span class="button-wrap"><span class="icon icon-cancel "></span><span class="visually-hidden">Clear search input</span></span></button><button type="submit" class="button action has-icon search-button"><span class="button-wrap"><span class="icon icon-search "></span><span class="visually-hidden">Search</span></span></button><div id="top-nav-search-menu" role="listbox" aria-labelledby="top-nav-search-label"></div></form></div><div class="theme-switcher-menu"><button type="button" class="button action has-icon theme-switcher-menu small" aria-haspopup="menu"><span class="button-wrap"><span class="icon icon-theme-os-default "></span>Theme</span></button></div><ul class="auth-container"><li><a href="/users/fxa/login/authenticate/?next=%2Fzh-CN%2Fdocs%2FMDN%2FWriting_guidelines" class="login-link" rel="nofollow">Log in</a></li><li><a href="/users/fxa/login/authenticate/?next=%2Fzh-CN%2Fdocs%2FMDN%2FWriting_guidelines" target="_self" rel="nofollow" class="button primary mdn-plus-subscribe-link"><span class="button-wrap">Sign up for free</span></a></li></ul></div></div></header><div class="article-actions-container"><div class="container"><button type="button" class="button action has-icon sidebar-button" aria-label="Expand sidebar" aria-expanded="false" aria-controls="sidebar-quicklinks"><span class="button-wrap"><span class="icon icon-sidebar "></span></span></button><nav class="breadcrumbs-container" aria-label="Breadcrumb"><ol typeof="BreadcrumbList" vocab="https://schema.org/" aria-label="breadcrumbs"><li property="itemListElement" typeof="ListItem"><a href="/zh-CN/docs/MDN" class="breadcrumb" property="item" typeof="WebPage"><span property="name">MDN Web 文档项目</span></a><meta property="position" content="1"/></li><li property="itemListElement" typeof="ListItem"><a href="/zh-CN/docs/MDN/Writing_guidelines" class="breadcrumb-current-page" property="item" typeof="WebPage"><span property="name">撰写指南</span></a><meta property="position" content="2"/></li></ol></nav><div class="article-actions"><button type="button" class="button action has-icon article-actions-toggle" aria-label="Article actions"><span class="button-wrap"><span class="icon icon-ellipses "></span><span class="article-actions-dialog-heading">Article Actions</span></span></button><ul class="article-actions-entries"><li class="article-actions-entry"><div class="languages-switcher-menu open-on-focus-within"><button id="languages-switcher-button" type="button" class="button action small has-icon languages-switcher-menu" aria-haspopup="menu"><span class="button-wrap"><span class="icon icon-language "></span>中文 (简体)</span></button><div class="hidden"><ul class="submenu language-menu " aria-labelledby="language-menu-button"><li class=" "><form class="submenu-item locale-redirect-setting"><div class="group"><label class="switch"><input type="checkbox" name="locale-redirect"/><span class="slider"></span><span class="label">Remember language</span></label><a href="https://github.com/orgs/mdn/discussions/739" rel="external noopener noreferrer" target="_blank" title="Enable this setting to automatically switch to this language when it's available. (Click to learn more.)"><span class="icon icon-question-mark "></span></a></div></form></li><li class=" "><a data-locale="de" href="/de/docs/MDN/Writing_guidelines" class="button submenu-item"><span>Deutsch</span><span title="Diese Übersetzung ist Teil eines Experiments."><span class="icon icon-experimental "></span></span></a></li><li class=" "><a data-locale="en-US" href="/en-US/docs/MDN/Writing_guidelines" class="button submenu-item"><span>English (US)</span></a></li><li class=" "><a data-locale="es" href="/es/docs/MDN/Writing_guidelines" class="button submenu-item"><span>Español</span></a></li><li class=" "><a data-locale="fr" href="/fr/docs/MDN/Writing_guidelines" class="button submenu-item"><span>Français</span></a></li><li class=" "><a data-locale="ja" href="/ja/docs/MDN/Writing_guidelines" class="button submenu-item"><span>日本語</span></a></li><li class=" "><a data-locale="ko" href="/ko/docs/MDN/Writing_guidelines" class="button submenu-item"><span>한국어</span></a></li><li class=" "><a data-locale="pt-BR" href="/pt-BR/docs/MDN/Writing_guidelines" class="button submenu-item"><span>Português (do Brasil)</span></a></li><li class=" "><a data-locale="ru" href="/ru/docs/MDN/Writing_guidelines" class="button submenu-item"><span>Русский</span></a></li><li class=" "><a data-locale="zh-TW" href="/zh-TW/docs/MDN/Writing_guidelines" class="button submenu-item"><span>正體中文 (繁體)</span></a></li></ul></div></div></li></ul></div></div></div></div><div class="container"><div class="notecard localized-content-note"><p><a href="/zh-CN/docs/MDN/Community/Contributing/Translated_content#活跃语言">此页面由社区从英文翻译而来。了解更多并加入 MDN Web Docs 社区。</a></p></div></div><div class="main-wrapper"><div class="sidebar-container"><aside id="sidebar-quicklinks" class="sidebar" data-macro="MDNSidebar"><button type="button" class="button action backdrop" aria-label="Collapse sidebar"><span class="button-wrap"></span></button><nav aria-label="Related Topics" class="sidebar-inner"><header class="sidebar-actions"><section class="sidebar-filter-container"><div class="sidebar-filter "><label id="sidebar-filter-label" class="sidebar-filter-label" for="sidebar-filter-input"><span class="icon icon-filter"></span><span class="visually-hidden">Filter sidebar</span></label><input id="sidebar-filter-input" autoComplete="off" class="sidebar-filter-input-field false" type="text" placeholder="Filter" value=""/><button type="button" class="button action has-icon clear-sidebar-filter-button"><span class="button-wrap"><span class="icon icon-cancel "></span><span class="visually-hidden">Clear filter input</span></span></button></div></section></header><div class="sidebar-inner-nav"><div class="in-nav-toc"></div><div class="sidebar-body"><ol><li><a href="/zh-CN/docs/MDN">MDN Web 文档项目</a></li><li class="toggle"><details><summary>社区指南</summary><ol><li><a href="/zh-CN/docs/MDN/Community">社区准则</a></li><li class="toggle"><details><summary>为 MDN 做贡献</summary><ol><li><a href="/zh-CN/docs/MDN/Community/Contributing">为 MDN Web 文档作贡献</a></li><li><a href="/zh-CN/docs/MDN/Community/Contributing/Getting_started">初识 MDN Web 文档</a></li><li><a href="/zh-CN/docs/MDN/Community/Contributing/Our_repositories">MDN Web 文档仓库</a></li><li><a href="/zh-CN/docs/MDN/Community/Contributing/Translated_content">MDN Web 文档的本地化</a></li><li><a href="/zh-CN/docs/MDN/Community/Contributing/Security_vulnerability_response">安全漏洞响应步骤</a></li></ol></details></li><li><a href="/zh-CN/docs/MDN/Community/Open_source_etiquette">开源项目礼节</a></li><li><a href="/zh-CN/docs/MDN/Community/Communication_channels">沟通渠道</a></li><li><a href="/zh-CN/docs/MDN/Community/Discussions">社区讨论</a></li><li><a href="/zh-CN/docs/MDN/Community/Learn_forum">学习论坛</a></li><li><a href="/zh-CN/docs/MDN/Community/Issues">创建和解决议题指南</a></li><li><a href="/zh-CN/docs/MDN/Community/Pull_requests">拉取请求的提交和审查指南</a></li><li><a href="/zh-CN/docs/MDN/Community/Roles_teams">MDN Web 文档角色和团队</a></li></ol></details></li><li class="toggle"><details open=""><summary>撰写指南</summary><ol><li><em><a href="/zh-CN/docs/MDN/Writing_guidelines" aria-current="page">撰写指南</a></em></li><li><a href="/zh-CN/docs/MDN/Writing_guidelines/What_we_write">MDN 收录规则</a></li><li><a href="/zh-CN/docs/MDN/Writing_guidelines/Writing_style_guide">文档写作规范</a></li><li class="toggle"><details><summary>MDN 写作指南</summary><ol><li><a href="/zh-CN/docs/MDN/Writing_guidelines/Howto">MDN Web 文档写作指南</a></li><li><a href="/zh-CN/docs/MDN/Writing_guidelines/Howto/Images_media">如何添加图像和媒体</a></li><li><a href="/zh-CN/docs/MDN/Writing_guidelines/Howto/Creating_moving_deleting">如何创建、移动、删除及编辑页面</a></li><li><a href="/zh-CN/docs/MDN/Writing_guidelines/Howto/Document_a_CSS_property">如何记录 CSS 属性</a></li><li><a href="/zh-CN/docs/MDN/Writing_guidelines/Howto/Document_an_HTTP_header">如何记录 HTTP 标头</a></li><li><a href="/zh-CN/docs/MDN/Writing_guidelines/Howto/Document_web_errors">如何记录 web 错误</a></li><li><a href="/zh-CN/docs/MDN/Writing_guidelines/Howto/Research_technology">如何研究一项技术</a></li><li><a href="/zh-CN/docs/MDN/Writing_guidelines/Howto/JSON_Structured_data">如何使用结构化数据</a></li><li><a href="/zh-CN/docs/MDN/Writing_guidelines/Howto/Write_an_api_reference">如何撰写 API 参考文档</a></li><li><a href="/zh-CN/docs/MDN/Writing_guidelines/Howto/Write_a_new_entry_in_the_glossary">如何撰写和引用一个术语表中的条目</a></li><li><a href="/zh-CN/docs/MDN/Writing_guidelines/Howto/Markdown_in_MDN">如何使用 Markdown 来撰写文档</a></li></ol></details></li><li class="toggle"><details><summary>页面结构</summary><ol><li><a href="/zh-CN/docs/MDN/Writing_guidelines/Page_structures">文档结构</a></li><li><a href="/zh-CN/docs/MDN/Writing_guidelines/Page_structures/Banners_and_notices">横幅和通知</a></li><li><a href="/zh-CN/docs/MDN/Writing_guidelines/Page_structures/Code_examples">代码示例</a></li><li><a href="/zh-CN/docs/MDN/Writing_guidelines/Page_structures/Compatibility_tables">兼容性表格和浏览器兼容性数据仓库（BCD）</a></li><li><a href="/zh-CN/docs/MDN/Writing_guidelines/Page_structures/Live_samples">运行实例</a></li><li><a href="/zh-CN/docs/MDN/Writing_guidelines/Page_structures/Page_types">页面类型</a></li><li><a href="/zh-CN/docs/MDN/Writing_guidelines/Page_structures/Sidebars">侧边栏</a></li><li><a href="/zh-CN/docs/MDN/Writing_guidelines/Page_structures/Specification_tables">规范表格</a></li><li><a href="/zh-CN/docs/MDN/Writing_guidelines/Page_structures/Syntax_sections">语法小节</a></li><li><a href="/zh-CN/docs/MDN/Writing_guidelines/Page_structures/Macros">使用宏</a></li><li><a href="/zh-CN/docs/MDN/Writing_guidelines/Page_structures/Feature_status">特性状态</a></li></ol></details></li><li><a href="/zh-CN/docs/MDN/Writing_guidelines/Attrib_copyright_license">署名和版权许可</a></li><li><a href="/zh-CN/docs/MDN/Writing_guidelines/Experimental_deprecated_obsolete">实验性、已弃用和过时</a></li></ol></details></li><li class="toggle"><details><summary>Advisory Board</summary><ol><li><a href="/zh-CN/docs/MDN/MDN_Product_Advisory_Board">MDN 产品咨询委员会</a></li><li><a class="only-in-en-us" title="此页面目前仅提供英文版本" href="/en-US/docs/MDN/MDN_Product_Advisory_Board/Membership">Product Advisory Board Charter & Membership</a></li></ol></details></li><li class="toggle"><details><summary>History</summary><ol><li><a href="/zh-CN/docs/MDN/At_ten">Mozilla 开发者网络 10 周年</a></li><li><a class="only-in-en-us" title="此页面目前仅提供英文版本" href="/en-US/docs/MDN/At_ten/History_of_MDN">The history of MDN</a></li></ol></details></li><li><a class="only-in-en-us" title="此页面目前仅提供英文版本" href="/en-US/docs/MDN/Changelog">MDN Web Docs changelog</a></li></ol></div></div><section class="place side"></section></nav></aside><div class="toc-container"><aside class="toc"><nav></nav></aside><section class="place side"></section></div></div><main id="content" class="main-content "><article class="main-page-content" lang="zh-CN"><header><h1>撰写指南</h1></header><div class="section-content"><p>MDN Web 文档是一个开源项目。下面的概述部分描述了有关我们在 MDN Web 文档上撰写<em>什么</em>文档以及<em>如何</em>撰写文档的指南。学习<em>如何做出贡献</em>，请参见我们的<a href="/zh-CN/docs/MDN/Community">贡献指南</a>。</p> <dl> <dt id="撰写的文档内容"><a href="/zh-CN/docs/MDN/Writing_guidelines/What_we_write">撰写的文档内容</a></dt> <dd> <p>本节涵盖了我们在 MDN Web 文档中包含的内容和我们不希望包含的内容，以及其他的政策，如：我们何时为新技术撰写文档、内容建议流程和我们是否接受外链。如果你正在考虑为我们撰写或更新内容，这是一个很好的入门内容。本节还包括：</p> <dl> <dt id="包含的标准"><a href="/zh-CN/docs/MDN/Writing_guidelines/What_we_write/Criteria_for_inclusion">包含的标准</a></dt> <dd> <p>本文提供了要将内容添加到 MDN Web 文档的深入标准、在 MDN Web 文档添加新文档的申请流程，以及申请的期望和指南。</p> </dd> </dl> </dd> <dt id="文档写作规范"><a href="/zh-CN/docs/MDN/Writing_guidelines/Writing_style_guide">文档写作规范</a></dt> <dd> <p>文档写作规范涵盖了我们在 MDN Web 文档上使用的语言和格式。它也包含了如何<a href="/zh-CN/docs/MDN/Writing_guidelines/Writing_style_guide/Code_style_guide">格式化代码示例</a>。</p> </dd> <dt id="如何撰写_mdn_web_文档"><a href="/zh-CN/docs/MDN/Writing_guidelines/Howto">如何撰写 MDN Web 文档</a></dt> <dd> <p>本节涵盖了与创建和编辑页面有关的所有内容，包括我们遵循的流程和技术。本节提供有关入门的信息、页面结构概述，以及在哪里可以找到有关特定任务的操作方法。本节包括以下主题：</p> <dl> <dt id="如何研究一项技术"><a href="/zh-CN/docs/MDN/Writing_guidelines/Howto/Research_technology">如何研究一项技术</a></dt> <dd> <p>本节为你提供了在撰写文档时研究一项技术的技巧。</p> </dd> <dt id="如何创建、移动和删除页面"><a href="/zh-CN/docs/MDN/Writing_guidelines/Howto/Creating_moving_deleting">如何创建、移动和删除页面</a></dt> <dd> <p>本节说明了我们应该如何创建、移动或删除 MDN Web 文档中的页面。它也解释了在移动和删除页面时，我们应该如何对页面进行重定向。</p> </dd> <dt id="如何使用_markdown"><a href="/zh-CN/docs/MDN/Writing_guidelines/Howto/Markdown_in_MDN">如何使用 markdown</a></dt> <dd> <p>我们使用的 markdown 格式源自 <a href="https://github.github.com/gfm/" class="external" target="_blank">GitHub 风格的 markdown（GFM）</a>。本节是我们在 MDN Web 文档中使用 markdown 的指南，包括特定页内组件的格式，例如特别声明的内容和定义列表。</p> </dd> <dt id="添加图像和媒体内容"><a href="/zh-CN/docs/MDN/Writing_guidelines/Howto/Images_media">添加图像和媒体内容</a></dt> <dd> <p>本节介绍了在页面中包含诸如图像等媒体内容的要求。</p> </dd> <dt id="如何撰写_css_属性文档"><a href="/zh-CN/docs/MDN/Writing_guidelines/Howto/Document_a_CSS_property">如何撰写 CSS 属性文档</a></dt> <dd> <p>本文介绍如何撰写 CSS 属性页面，包括布局和内容。</p> </dd> <dt id="如何撰写_api_参考文档"><a href="/zh-CN/docs/MDN/Writing_guidelines/Howto/Write_an_api_reference">如何撰写 API 参考文档</a></dt> <dd> <p>本节介绍了如何撰写 Web API 文档。</p> </dd> <dt id="如何撰写_http_标头文档"><a href="/zh-CN/docs/MDN/Writing_guidelines/Howto/Document_an_HTTP_header">如何撰写 HTTP 标头文档</a></dt> <dd> <p>本文介绍了如何创建 HTTP 标头的参考页面。</p> </dd> <dt id="向术语表添加条目"><a href="/zh-CN/docs/MDN/Writing_guidelines/Howto/Write_a_new_entry_in_the_glossary">向术语表添加条目</a></dt> <dd> <p>本节介绍了如何在 MDN Web 文档中添加术语条目以及链接到这些条目。它还提供了有关术语表条目的布局和内容的指南。</p> </dd> </dl> </dd> <dt id="mdn_web_文档上的页面类型"><a href="/zh-CN/docs/MDN/Writing_guidelines/Page_structures/Page_types">MDN Web 文档上的页面类型</a></dt> <dd> <p>不论是 CSS 参考页面还是 JavaScript 指南页面，MDN Web 文档上的每个页面都有特定的页面类型。本节列出了不同的页面类型并提供了每种类型的模板。浏览这个文档将有助于你了解你正在撰写的文档的类型。</p> </dd> <dt id="mdn_web_文档的页面结构"><a href="/zh-CN/docs/MDN/Writing_guidelines/Page_structures">MDN Web 文档的页面结构</a></dt> <dd> <p>本节介绍了我们用于在 MDN Web 文档中提供一致的信息呈现的各种页面结构。包括：</p> <dl> <dt id="语法部分"><a href="/zh-CN/docs/MDN/Writing_guidelines/Page_structures/Syntax_sections">语法部分</a></dt> <dd> <p>MDN Web 文档中的参考页面的语法部分包含一个语法框，用于定义一个特性的确切语法。本文介绍了如何为参考文档编写语法框。</p> </dd> <dt id="代码示例"><a href="/zh-CN/docs/MDN/Writing_guidelines/Page_structures/Code_examples">代码示例</a></dt> <dd> <p>在页面上包含示代码示例的方法很多，本节介绍了这些方法，并提供了不同语言的语法指南。</p> </dd> <dt id="横幅和说明"><a href="/zh-CN/docs/MDN/Writing_guidelines/Page_structures/Banners_and_notices">横幅和说明</a></dt> <dd> <p>有时，在文章中需要添加特殊的说明。如果页面中包含不推荐使用的技术或不应在生产环境中使用的其他内容，则可能会包含这些特殊说明。本文涵盖了最常见的情况，以及应该如何处理它们。</p> </dd> <dt id="规范表格"><a href="/zh-CN/docs/MDN/Writing_guidelines/Page_structures/Specification_tables">规范表格</a></dt> <dd> <p>MDN Web 文档中的每一个参考页面都应该提供有关定义该 API 或技术的规范信息。本文演示了这些表格的外观，并说明了添加的方法。</p> </dd> <dt id="兼容性表格"><a href="/zh-CN/docs/MDN/Writing_guidelines/Page_structures/Compatibility_tables">兼容性表格</a></dt> <dd> <p>MDN Web 文档为我们的开放式的 web 文档提供了兼容性表格的标准格式。本文说明了为用于生成兼容性表格的数据库添加和维护数据，以及如何将这些表格集成到文章中。</p> </dd> <dt id="宏"><a href="/zh-CN/docs/MDN/Writing_guidelines/Page_structures/Macros">宏</a></dt> <dd> <p>宏是页面中用于生成内容（例如侧边栏）的较为便捷的方式。本节列出了我们使用的宏以及它们的作用。</p> </dd> </dl> </dd> <dt id="署名和版权许可协议"><a href="/zh-CN/docs/MDN/Writing_guidelines/Attrib_copyright_license">署名和版权许可协议</a></dt> <dd> <p>描述在其他地方使用 MDN Web 文档内容的政策、如何获得重新发布 MDN 上的内容的许可，以及链接到 MDN 上的内容的相关说明。</p> </dd> <dt id="如何标记一项技术"><a href="/zh-CN/docs/MDN/Writing_guidelines/Experimental_deprecated_obsolete">如何标记一项技术</a></dt> <dd> <p>本节涵盖了我们对过时、弃用和实验性术语的定义以及使用这些术语去标记一项技术的情形，并提供了关于何时从 MDN Web 文档中删除相应内容的指南。</p> </dd> </dl></div></article><aside class="article-footer"><div class="article-footer-inner"><div class="svg-container"><svg xmlns="http://www.w3.org/2000/svg" width="162" height="162" viewBox="0 0 162 162" fill="none" role="none"><mask id="b" fill="#fff"><path d="M97.203 47.04c8.113-7.886 18.004-13.871 28.906-17.492a78 78 0 0 1 33.969-3.39c11.443 1.39 22.401 5.295 32.024 11.411s17.656 14.28 23.476 23.86c5.819 9.579 9.269 20.318 10.083 31.385a69.85 69.85 0 0 1-5.387 32.44c-4.358 10.272-11.115 19.443-19.747 26.801-8.632 7.359-18.908 12.709-30.034 15.637l-6.17-21.698c7.666-2.017 14.746-5.703 20.694-10.773 5.948-5.071 10.603-11.389 13.606-18.467a48.14 48.14 0 0 0 3.712-22.352c-.561-7.625-2.938-15.025-6.948-21.625s-9.544-12.226-16.175-16.44-14.181-6.904-22.065-7.863a53.75 53.75 0 0 0-23.405 2.336c-7.513 2.495-14.327 6.62-19.918 12.053z"></path></mask><path stroke="url(#a)" stroke-dasharray="6, 6" stroke-width="2" d="M97.203 47.04c8.113-7.886 18.004-13.871 28.906-17.492a78 78 0 0 1 33.969-3.39c11.443 1.39 22.401 5.295 32.024 11.411s17.656 14.28 23.476 23.86c5.819 9.579 9.269 20.318 10.083 31.385a69.85 69.85 0 0 1-5.387 32.44c-4.358 10.272-11.115 19.443-19.747 26.801-8.632 7.359-18.908 12.709-30.034 15.637l-6.17-21.698c7.666-2.017 14.746-5.703 20.694-10.773 5.948-5.071 10.603-11.389 13.606-18.467a48.14 48.14 0 0 0 3.712-22.352c-.561-7.625-2.938-15.025-6.948-21.625s-9.544-12.226-16.175-16.44-14.181-6.904-22.065-7.863a53.75 53.75 0 0 0-23.405 2.336c-7.513 2.495-14.327 6.62-19.918 12.053z" mask="url(#b)" style="stroke:url(#a)" transform="translate(-63.992 -25.587)"></path><ellipse cx="8.066" cy="111.597" fill="var(--background-tertiary)" rx="53.677" ry="53.699" transform="matrix(.71707 -.697 .7243 .6895 0 0)"></ellipse><g clip-path="url(#c)" transform="translate(-63.992 -25.587)"><path fill="#9abff5" d="m144.256 137.379 32.906 12.434a4.41 4.41 0 0 1 2.559 5.667l-9.326 24.679a4.41 4.41 0 0 1-5.667 2.559l-8.226-3.108-2.332 6.17c-.466 1.233-.375 1.883-1.609 1.417l-2.253-.527c-.411-.155-.95-.594-1.206-1.161l-4.734-10.484-12.545-4.741a4.41 4.41 0 0 1-2.559-5.667l9.325-24.679a4.41 4.41 0 0 1 5.667-2.559m9.961 29.617 8.227 3.108 3.264-8.638-.498-6.768-4.113-1.555.548 7.258-4.319-1.632zm-12.339-4.663 8.226 3.108 3.264-8.637-.498-6.769-4.113-1.554.548 7.257-4.319-1.632z"></path></g><g clip-path="url(#d)" transform="translate(-63.992 -25.587)"><path fill="#81b0f3" d="M135.35 60.136 86.67 41.654c-3.346-1.27-7.124.428-8.394 3.775L64.414 81.938c-1.27 3.347.428 7.125 3.774 8.395l12.17 4.62-3.465 9.128c-.693 1.826-1.432 2.457.394 3.15l3.014 1.625c.609.231 1.637.274 2.477-.104l15.53-6.983 18.56 7.047c3.346 1.27 7.124-.428 8.395-3.775l13.862-36.51c1.27-3.346-.428-7.124-3.775-8.395M95.261 83.207l-12.17-4.62 4.852-12.779 7.19-7.017 6.085 2.31-7.725 7.51 6.389 2.426zm18.255 6.93-12.17-4.62 4.852-12.778 7.189-7.017 6.085 2.31-7.725 7.51 6.39 2.426z"></path></g><defs><clipPath id="c"><path fill="#fff" d="m198.638 146.586-65.056-24.583-24.583 65.057 65.056 24.582z"></path></clipPath><clipPath id="d"><path fill="#fff" d="m66.438 14.055 96.242 36.54-36.54 96.243-96.243-36.54z"></path></clipPath><linearGradient id="a" x1="97.203" x2="199.995" y1="47.04" y2="152.793" gradientUnits="userSpaceOnUse"><stop stop-color="#086DFC"></stop><stop offset="0.246" stop-color="#2C81FA"></stop><stop offset="0.516" stop-color="#5497F8"></stop><stop offset="0.821" stop-color="#80B0F6"></stop><stop offset="1" stop-color="#9ABFF5"></stop></linearGradient></defs></svg></div><h2>Help improve MDN</h2><fieldset class="feedback"><label>Was this page helpful to you?</label><div class="button-container"><button type="button" class="button primary has-icon yes"><span class="button-wrap"><span class="icon icon-thumbs-up "></span>Yes</span></button><button type="button" class="button primary has-icon no"><span class="button-wrap"><span class="icon icon-thumbs-down "></span>No</span></button></div></fieldset><a class="contribute" href="https://github.com/mdn/translated-content/blob/main/CONTRIBUTING.md" title="This will take you to our contribution guidelines on GitHub." target="_blank" rel="noopener noreferrer">Learn how to contribute</a>.<p class="last-modified-date">This page was last modified on <time dateTime="2023-03-08T07:16:56.000Z">2023年3月8日</time> by <a href="/zh-CN/docs/MDN/Writing_guidelines/contributors.txt" rel="nofollow">MDN contributors</a>.</p><div id="on-github" class="on-github"><a href="https://github.com/mdn/translated-content/blob/main/files/zh-cn/mdn/writing_guidelines/index.md?plain=1" title="Folder: zh-cn/mdn/writing_guidelines (Opens in a new tab)" target="_blank" rel="noopener noreferrer">View this page on GitHub</a> • <a href="https://github.com/mdn/translated-content/issues/new?template=page-report-zh-cn.yml&mdn-url=https%3A%2F%2Fdeveloper.mozilla.org%2Fzh-CN%2Fdocs%2FMDN%2FWriting_guidelines&metadata=%3C%21--+Do+not+make+changes+below+this+line+--%3E%0A%3Cdetails%3E%0A%3Csummary%3EPage+report+details%3C%2Fsummary%3E%0A%0A*+Folder%3A+%60zh-cn%2Fmdn%2Fwriting_guidelines%60%0A*+MDN+URL%3A+https%3A%2F%2Fdeveloper.mozilla.org%2Fzh-CN%2Fdocs%2FMDN%2FWriting_guidelines%0A*+GitHub+URL%3A+https%3A%2F%2Fgithub.com%2Fmdn%2Ftranslated-content%2Fblob%2Fmain%2Ffiles%2Fzh-cn%2Fmdn%2Fwriting_guidelines%2Findex.md%0A*+Last+commit%3A+https%3A%2F%2Fgithub.com%2Fmdn%2Ftranslated-content%2Fcommit%2Fd7ed8f60c9d2542f2709f623e2cdc9355bbcc8d1%0A*+Document+last+modified%3A+2023-03-08T07%3A16%3A56.000Z%0A%0A%3C%2Fdetails%3E" title="This will take you to GitHub to file a new issue." target="_blank" rel="noopener noreferrer">Report a problem with this content</a></div></div></aside></main></div></div><footer id="nav-footer" class="page-footer"><div class="page-footer-grid"><div class="page-footer-logo-col"><a href="/" class="mdn-footer-logo" aria-label="MDN homepage"><svg width="48" height="17" viewBox="0 0 48 17" fill="none" xmlns="http://www.w3.org/2000/svg"><title id="mdn-footer-logo-svg">MDN logo</title><path d="M20.04 16.512H15.504V10.416C15.504 9.488 15.344 8.824 15.024 8.424C14.72 8.024 14.264 7.824 13.656 7.824C12.92 7.824 12.384 8.064 12.048 8.544C11.728 9.024 11.568 9.64 11.568 10.392V14.184H13.008V16.512H8.472V10.416C8.472 9.488 8.312 8.824 7.992 8.424C7.688 8.024 7.232 7.824 6.624 7.824C5.872 7.824 5.336 8.064 5.016 8.544C4.696 9.024 4.536 9.64 4.536 10.392V14.184H6.6V16.512H0V14.184H1.44V8.04H0.024V5.688H4.536V7.32C5.224 6.088 6.32 5.472 7.824 5.472C8.608 5.472 9.328 5.664 9.984 6.048C10.64 6.432 11.096 7.016 11.352 7.8C11.992 6.248 13.168 5.472 14.88 5.472C15.856 5.472 16.72 5.776 17.472 6.384C18.224 6.992 18.6 7.936 18.6 9.216V14.184H20.04V16.512Z" fill="currentColor"></path><path d="M33.6714 16.512H29.1354V14.496C28.8314 15.12 28.3834 15.656 27.7914 16.104C27.1994 16.536 26.4154 16.752 25.4394 16.752C24.0154 16.752 22.8954 16.264 22.0794 15.288C21.2634 14.312 20.8554 12.984 20.8554 11.304C20.8554 9.688 21.2554 8.312 22.0554 7.176C22.8554 6.04 24.0634 5.472 25.6794 5.472C26.5594 5.472 27.2794 5.648 27.8394 6C28.3994 6.352 28.8314 6.8 29.1354 7.344V2.352H26.9754V0H32.2314V14.184H33.6714V16.512ZM29.1354 11.04V10.776C29.1354 9.88 28.8954 9.184 28.4154 8.688C27.9514 8.176 27.3674 7.92 26.6634 7.92C25.9754 7.92 25.3674 8.176 24.8394 8.688C24.3274 9.2 24.0714 10.008 24.0714 11.112C24.0714 12.152 24.3114 12.944 24.7914 13.488C25.2714 14.032 25.8394 14.304 26.4954 14.304C27.3114 14.304 27.9514 13.96 28.4154 13.272C28.8954 12.584 29.1354 11.84 29.1354 11.04Z" fill="currentColor"></path><path d="M47.9589 16.512H41.9829V14.184H43.4229V10.416C43.4229 9.488 43.2629 8.824 42.9429 8.424C42.6389 8.024 42.1829 7.824 41.5749 7.824C40.8389 7.824 40.2709 8.056 39.8709 8.52C39.4709 8.968 39.2629 9.56 39.2469 10.296V14.184H40.6869V16.512H34.7109V14.184H36.1509V8.04H34.5909V5.688H39.2469V7.344C39.9669 6.096 41.1269 5.472 42.7269 5.472C43.7509 5.472 44.6389 5.776 45.3909 6.384C46.1429 6.992 46.5189 7.936 46.5189 9.216V14.184H47.9589V16.512Z" fill="currentColor"></path></svg></a><p>Your blueprint for a better internet.</p><ul class="social-icons"><li><a href="https://mozilla.social/@mdn" target="_blank" rel="me noopener noreferrer"><span class="icon icon-mastodon"></span><span class="visually-hidden">MDN on Mastodon</span></a></li><li><a href="https://twitter.com/mozdevnet" target="_blank" rel="noopener noreferrer"><span class="icon icon-twitter-x"></span><span class="visually-hidden">MDN on X (formerly Twitter)</span></a></li><li><a href="https://github.com/mdn/" target="_blank" rel="noopener noreferrer"><span class="icon icon-github-mark-small"></span><span class="visually-hidden">MDN on GitHub</span></a></li><li><a href="/en-US/blog/rss.xml" target="_blank"><span class="icon icon-feed"></span><span class="visually-hidden">MDN Blog RSS Feed</span></a></li></ul></div><div class="page-footer-nav-col-1"><h2 class="footer-nav-heading">MDN</h2><ul class="footer-nav-list"><li class="footer-nav-item"><a href="/en-US/about">About</a></li><li class="footer-nav-item"><a href="/en-US/blog/">Blog</a></li><li class="footer-nav-item"><a href="https://www.mozilla.org/en-US/careers/listings/?team=ProdOps" target="_blank" rel="noopener noreferrer">Careers</a></li><li class="footer-nav-item"><a href="/en-US/advertising">Advertise with us</a></li></ul></div><div class="page-footer-nav-col-2"><h2 class="footer-nav-heading">Support</h2><ul class="footer-nav-list"><li class="footer-nav-item"><a class="footer-nav-link" href="https://support.mozilla.org/products/mdn-plus">Product help</a></li><li class="footer-nav-item"><a class="footer-nav-link" href="/zh-CN/docs/MDN/Community/Issues">Report an issue</a></li></ul></div><div class="page-footer-nav-col-3"><h2 class="footer-nav-heading">Our communities</h2><ul class="footer-nav-list"><li class="footer-nav-item"><a class="footer-nav-link" href="/en-US/community">MDN Community</a></li><li class="footer-nav-item"><a class="footer-nav-link" href="https://discourse.mozilla.org/c/mdn/236" target="_blank" rel="noopener noreferrer">MDN Forum</a></li><li class="footer-nav-item"><a class="footer-nav-link" href="/discord" target="_blank" rel="noopener noreferrer">MDN Chat</a></li></ul></div><div class="page-footer-nav-col-4"><h2 class="footer-nav-heading">Developers</h2><ul class="footer-nav-list"><li class="footer-nav-item"><a class="footer-nav-link" href="/zh-CN/docs/Web">Web Technologies</a></li><li class="footer-nav-item"><a class="footer-nav-link" href="/zh-CN/docs/Learn">Learn Web Development</a></li><li class="footer-nav-item"><a class="footer-nav-link" href="/zh-CN/plus">MDN Plus</a></li><li class="footer-nav-item"><a href="https://hacks.mozilla.org/" target="_blank" rel="noopener noreferrer">Hacks Blog</a></li></ul></div><div class="page-footer-moz"><a href="https://www.mozilla.org/" class="footer-moz-logo-link" target="_blank" rel="noopener noreferrer"><svg width="112" height="32" fill="none" xmlns="http://www.w3.org/2000/svg"><title id="mozilla-footer-logo-svg">Mozilla logo</title><path d="M41.753 14.218c-2.048 0-3.324 1.522-3.324 4.157 0 2.423 1.119 4.286 3.29 4.286 2.082 0 3.447-1.678 3.447-4.347 0-2.826-1.522-4.096-3.413-4.096Zm54.89 7.044c0 .901.437 1.618 1.645 1.618 1.427 0 2.949-1.024 3.044-3.352-.649-.095-1.365-.185-2.02-.185-1.426-.005-2.668.397-2.668 1.92Z" fill="currentColor"></path><path d="M0 0v32h111.908V0H0Zm32.56 25.426h-5.87v-7.884c0-2.423-.806-3.352-2.39-3.352-1.924 0-2.702 1.365-2.702 3.324v4.868h1.864v3.044h-5.864v-7.884c0-2.423-.806-3.352-2.39-3.352-1.924 0-2.702 1.365-2.702 3.324v4.868h2.669v3.044H6.642v-3.044h1.863v-7.918H6.642V11.42h5.864v2.11c.839-1.489 2.3-2.39 4.252-2.39 2.02 0 3.878.963 4.566 3.01.778-1.862 2.361-3.01 4.566-3.01 2.512 0 4.812 1.522 4.812 4.84v6.402h1.863v3.044h-.005Zm9.036.307c-4.314 0-7.296-2.635-7.296-7.106 0-4.096 2.484-7.481 7.514-7.481s7.481 3.38 7.481 7.29c0 4.472-3.228 7.297-7.699 7.297Zm22.578-.307H51.942l-.403-2.11 7.7-8.846h-4.376l-.621 2.17-2.888-.313.498-4.907h12.294l.313 2.11-7.767 8.852h4.533l.654-2.172 3.167.308-.872 4.908Zm7.99 0h-4.191v-5.03h4.19v5.03Zm0-8.976h-4.191v-5.03h4.19v5.03Zm2.618 8.976 6.054-21.358h3.945l-6.054 21.358h-3.945Zm8.136 0 6.048-21.358h3.945l-6.054 21.358h-3.939Zm21.486.307c-1.863 0-2.887-1.085-3.072-2.792-.805 1.427-2.232 2.792-4.498 2.792-2.02 0-4.314-1.085-4.314-4.006 0-3.447 3.323-4.253 6.518-4.253.778 0 1.584.034 2.3.124v-.465c0-1.427-.034-3.133-2.3-3.133-.84 0-1.488.061-2.143.402l-.453 1.578-3.195-.34.549-3.224c2.45-.996 3.692-1.27 5.992-1.27 3.01 0 5.556 1.55 5.556 4.75v6.083c0 .805.314 1.085.963 1.085.184 0 .375-.034.587-.095l.034 2.11a5.432 5.432 0 0 1-2.524.654Z" fill="currentColor"></path></svg></a><ul class="footer-moz-list"><li class="footer-moz-item"><a href="https://www.mozilla.org/privacy/websites/" class="footer-moz-link" target="_blank" rel="noopener noreferrer">Website Privacy Notice</a></li><li class="footer-moz-item"><a href="https://www.mozilla.org/privacy/websites/#cookies" class="footer-moz-link" target="_blank" rel="noopener noreferrer">Cookies</a></li><li class="footer-moz-item"><a href="https://www.mozilla.org/about/legal/terms/mozilla" class="footer-moz-link" target="_blank" rel="noopener noreferrer">Legal</a></li><li class="footer-moz-item"><a href="https://www.mozilla.org/about/governance/policies/participation/" class="footer-moz-link" target="_blank" rel="noopener noreferrer">Community Participation Guidelines</a></li></ul></div><div class="page-footer-legal"><p id="license" class="page-footer-legal-text">Visit <a href="https://www.mozilla.org" target="_blank" rel="noopener noreferrer">Mozilla Corporation’s</a> not-for-profit parent, the <a target="_blank" rel="noopener noreferrer" href="https://foundation.mozilla.org/">Mozilla Foundation</a>.<br/>Portions of this content are ©1998–2024 by individual mozilla.org contributors. Content available under <a href="/zh-CN/docs/MDN/Writing_guidelines/Attrib_copyright_license">a Creative Commons license</a>.</p></div></div></footer></div><script type="application/json" id="hydration">{"url":"/zh-CN/docs/MDN/Writing_guidelines","doc":{"isMarkdown":true,"isTranslated":true,"isActive":true,"flaws":{},"title":"撰写指南","mdn_url":"/zh-CN/docs/MDN/Writing_guidelines","locale":"zh-CN","native":"中文 (简体)","sidebarHTML":"<ol><li><a href=\"/zh-CN/docs/MDN\">MDN Web 文档项目</a></li><li class=\"toggle\"><details><summary>社区指南</summary><ol><li><a href=\"/zh-CN/docs/MDN/Community\">社区准则</a></li><li class=\"toggle\"><details><summary>为 MDN 做贡献</summary><ol><li><a href=\"/zh-CN/docs/MDN/Community/Contributing\">为 MDN Web 文档作贡献</a></li><li><a href=\"/zh-CN/docs/MDN/Community/Contributing/Getting_started\">初识 MDN Web 文档</a></li><li><a href=\"/zh-CN/docs/MDN/Community/Contributing/Our_repositories\">MDN Web 文档仓库</a></li><li><a href=\"/zh-CN/docs/MDN/Community/Contributing/Translated_content\">MDN Web 文档的本地化</a></li><li><a href=\"/zh-CN/docs/MDN/Community/Contributing/Security_vulnerability_response\">安全漏洞响应步骤</a></li></ol></details></li><li><a href=\"/zh-CN/docs/MDN/Community/Open_source_etiquette\">开源项目礼节</a></li><li><a href=\"/zh-CN/docs/MDN/Community/Communication_channels\">沟通渠道</a></li><li><a href=\"/zh-CN/docs/MDN/Community/Discussions\">社区讨论</a></li><li><a href=\"/zh-CN/docs/MDN/Community/Learn_forum\">学习论坛</a></li><li><a href=\"/zh-CN/docs/MDN/Community/Issues\">创建和解决议题指南</a></li><li><a href=\"/zh-CN/docs/MDN/Community/Pull_requests\">拉取请求的提交和审查指南</a></li><li><a href=\"/zh-CN/docs/MDN/Community/Roles_teams\">MDN Web 文档角色和团队</a></li></ol></details></li><li class=\"toggle\"><details open=\"\"><summary>撰写指南</summary><ol><li><em><a href=\"/zh-CN/docs/MDN/Writing_guidelines\" aria-current=\"page\">撰写指南</a></em></li><li><a href=\"/zh-CN/docs/MDN/Writing_guidelines/What_we_write\">MDN 收录规则</a></li><li><a href=\"/zh-CN/docs/MDN/Writing_guidelines/Writing_style_guide\">文档写作规范</a></li><li class=\"toggle\"><details><summary>MDN 写作指南</summary><ol><li><a href=\"/zh-CN/docs/MDN/Writing_guidelines/Howto\">MDN Web 文档写作指南</a></li><li><a href=\"/zh-CN/docs/MDN/Writing_guidelines/Howto/Images_media\">如何添加图像和媒体</a></li><li><a href=\"/zh-CN/docs/MDN/Writing_guidelines/Howto/Creating_moving_deleting\">如何创建、移动、删除及编辑页面</a></li><li><a href=\"/zh-CN/docs/MDN/Writing_guidelines/Howto/Document_a_CSS_property\">如何记录 CSS 属性</a></li><li><a href=\"/zh-CN/docs/MDN/Writing_guidelines/Howto/Document_an_HTTP_header\">如何记录 HTTP 标头</a></li><li><a href=\"/zh-CN/docs/MDN/Writing_guidelines/Howto/Document_web_errors\">如何记录 web 错误</a></li><li><a href=\"/zh-CN/docs/MDN/Writing_guidelines/Howto/Research_technology\">如何研究一项技术</a></li><li><a href=\"/zh-CN/docs/MDN/Writing_guidelines/Howto/JSON_Structured_data\">如何使用结构化数据</a></li><li><a href=\"/zh-CN/docs/MDN/Writing_guidelines/Howto/Write_an_api_reference\">如何撰写 API 参考文档</a></li><li><a href=\"/zh-CN/docs/MDN/Writing_guidelines/Howto/Write_a_new_entry_in_the_glossary\">如何撰写和引用一个术语表中的条目</a></li><li><a href=\"/zh-CN/docs/MDN/Writing_guidelines/Howto/Markdown_in_MDN\">如何使用 Markdown 来撰写文档</a></li></ol></details></li><li class=\"toggle\"><details><summary>页面结构</summary><ol><li><a href=\"/zh-CN/docs/MDN/Writing_guidelines/Page_structures\">文档结构</a></li><li><a href=\"/zh-CN/docs/MDN/Writing_guidelines/Page_structures/Banners_and_notices\">横幅和通知</a></li><li><a href=\"/zh-CN/docs/MDN/Writing_guidelines/Page_structures/Code_examples\">代码示例</a></li><li><a href=\"/zh-CN/docs/MDN/Writing_guidelines/Page_structures/Compatibility_tables\">兼容性表格和浏览器兼容性数据仓库（BCD）</a></li><li><a href=\"/zh-CN/docs/MDN/Writing_guidelines/Page_structures/Live_samples\">运行实例</a></li><li><a href=\"/zh-CN/docs/MDN/Writing_guidelines/Page_structures/Page_types\">页面类型</a></li><li><a href=\"/zh-CN/docs/MDN/Writing_guidelines/Page_structures/Sidebars\">侧边栏</a></li><li><a href=\"/zh-CN/docs/MDN/Writing_guidelines/Page_structures/Specification_tables\">规范表格</a></li><li><a href=\"/zh-CN/docs/MDN/Writing_guidelines/Page_structures/Syntax_sections\">语法小节</a></li><li><a href=\"/zh-CN/docs/MDN/Writing_guidelines/Page_structures/Macros\">使用宏</a></li><li><a href=\"/zh-CN/docs/MDN/Writing_guidelines/Page_structures/Feature_status\">特性状态</a></li></ol></details></li><li><a href=\"/zh-CN/docs/MDN/Writing_guidelines/Attrib_copyright_license\">署名和版权许可</a></li><li><a href=\"/zh-CN/docs/MDN/Writing_guidelines/Experimental_deprecated_obsolete\">实验性、已弃用和过时</a></li></ol></details></li><li class=\"toggle\"><details><summary>Advisory Board</summary><ol><li><a href=\"/zh-CN/docs/MDN/MDN_Product_Advisory_Board\">MDN 产品咨询委员会</a></li><li><a class=\"only-in-en-us\" title=\"此页面目前仅提供英文版本\" href=\"/en-US/docs/MDN/MDN_Product_Advisory_Board/Membership\">Product Advisory Board Charter & Membership</a></li></ol></details></li><li class=\"toggle\"><details><summary>History</summary><ol><li><a href=\"/zh-CN/docs/MDN/At_ten\">Mozilla 开发者网络 10 周年</a></li><li><a class=\"only-in-en-us\" title=\"此页面目前仅提供英文版本\" href=\"/en-US/docs/MDN/At_ten/History_of_MDN\">The history of MDN</a></li></ol></details></li><li><a class=\"only-in-en-us\" title=\"此页面目前仅提供英文版本\" href=\"/en-US/docs/MDN/Changelog\">MDN Web Docs changelog</a></li></ol>","sidebarMacro":"MDNSidebar","body":[{"type":"prose","value":{"id":null,"title":null,"isH3":false,"content":"<p>MDN Web 文档是一个开源项目。下面的概述部分描述了有关我们在 MDN Web 文档上撰写<em>什么</em>文档以及<em>如何</em>撰写文档的指南。学习<em>如何做出贡献</em>，请参见我们的<a href=\"/zh-CN/docs/MDN/Community\">贡献指南</a>。</p>\n<dl>\n <dt id=\"撰写的文档内容\"><a href=\"/zh-CN/docs/MDN/Writing_guidelines/What_we_write\">撰写的文档内容</a></dt>\n <dd>\n <p>本节涵盖了我们在 MDN Web 文档中包含的内容和我们不希望包含的内容，以及其他的政策，如：我们何时为新技术撰写文档、内容建议流程和我们是否接受外链。如果你正在考虑为我们撰写或更新内容，这是一个很好的入门内容。本节还包括：</p>\n <dl>\n <dt id=\"包含的标准\"><a href=\"/zh-CN/docs/MDN/Writing_guidelines/What_we_write/Criteria_for_inclusion\">包含的标准</a></dt>\n <dd>\n <p>本文提供了要将内容添加到 MDN Web 文档的深入标准、在 MDN Web 文档添加新文档的申请流程，以及申请的期望和指南。</p>\n </dd>\n </dl>\n </dd>\n <dt id=\"文档写作规范\"><a href=\"/zh-CN/docs/MDN/Writing_guidelines/Writing_style_guide\">文档写作规范</a></dt>\n <dd>\n <p>文档写作规范涵盖了我们在 MDN Web 文档上使用的语言和格式。它也包含了如何<a href=\"/zh-CN/docs/MDN/Writing_guidelines/Writing_style_guide/Code_style_guide\">格式化代码示例</a>。</p>\n </dd>\n <dt id=\"如何撰写_mdn_web_文档\"><a href=\"/zh-CN/docs/MDN/Writing_guidelines/Howto\">如何撰写 MDN Web 文档</a></dt>\n <dd>\n <p>本节涵盖了与创建和编辑页面有关的所有内容，包括我们遵循的流程和技术。本节提供有关入门的信息、页面结构概述，以及在哪里可以找到有关特定任务的操作方法。本节包括以下主题：</p>\n <dl>\n <dt id=\"如何研究一项技术\"><a href=\"/zh-CN/docs/MDN/Writing_guidelines/Howto/Research_technology\">如何研究一项技术</a></dt>\n <dd>\n <p>本节为你提供了在撰写文档时研究一项技术的技巧。</p>\n </dd>\n <dt id=\"如何创建、移动和删除页面\"><a href=\"/zh-CN/docs/MDN/Writing_guidelines/Howto/Creating_moving_deleting\">如何创建、移动和删除页面</a></dt>\n <dd>\n <p>本节说明了我们应该如何创建、移动或删除 MDN Web 文档中的页面。它也解释了在移动和删除页面时，我们应该如何对页面进行重定向。</p>\n </dd>\n <dt id=\"如何使用_markdown\"><a href=\"/zh-CN/docs/MDN/Writing_guidelines/Howto/Markdown_in_MDN\">如何使用 markdown</a></dt>\n <dd>\n <p>我们使用的 markdown 格式源自 <a href=\"https://github.github.com/gfm/\" class=\"external\" target=\"_blank\">GitHub 风格的 markdown（GFM）</a>。本节是我们在 MDN Web 文档中使用 markdown 的指南，包括特定页内组件的格式，例如特别声明的内容和定义列表。</p>\n </dd>\n <dt id=\"添加图像和媒体内容\"><a href=\"/zh-CN/docs/MDN/Writing_guidelines/Howto/Images_media\">添加图像和媒体内容</a></dt>\n <dd>\n <p>本节介绍了在页面中包含诸如图像等媒体内容的要求。</p>\n </dd>\n <dt id=\"如何撰写_css_属性文档\"><a href=\"/zh-CN/docs/MDN/Writing_guidelines/Howto/Document_a_CSS_property\">如何撰写 CSS 属性文档</a></dt>\n <dd>\n <p>本文介绍如何撰写 CSS 属性页面，包括布局和内容。</p>\n </dd>\n <dt id=\"如何撰写_api_参考文档\"><a href=\"/zh-CN/docs/MDN/Writing_guidelines/Howto/Write_an_api_reference\">如何撰写 API 参考文档</a></dt>\n <dd>\n <p>本节介绍了如何撰写 Web API 文档。</p>\n </dd>\n <dt id=\"如何撰写_http_标头文档\"><a href=\"/zh-CN/docs/MDN/Writing_guidelines/Howto/Document_an_HTTP_header\">如何撰写 HTTP 标头文档</a></dt>\n <dd>\n <p>本文介绍了如何创建 HTTP 标头的参考页面。</p>\n </dd>\n <dt id=\"向术语表添加条目\"><a href=\"/zh-CN/docs/MDN/Writing_guidelines/Howto/Write_a_new_entry_in_the_glossary\">向术语表添加条目</a></dt>\n <dd>\n <p>本节介绍了如何在 MDN Web 文档中添加术语条目以及链接到这些条目。它还提供了有关术语表条目的布局和内容的指南。</p>\n </dd>\n </dl>\n </dd>\n <dt id=\"mdn_web_文档上的页面类型\"><a href=\"/zh-CN/docs/MDN/Writing_guidelines/Page_structures/Page_types\">MDN Web 文档上的页面类型</a></dt>\n <dd>\n <p>不论是 CSS 参考页面还是 JavaScript 指南页面，MDN Web 文档上的每个页面都有特定的页面类型。本节列出了不同的页面类型并提供了每种类型的模板。浏览这个文档将有助于你了解你正在撰写的文档的类型。</p>\n </dd>\n <dt id=\"mdn_web_文档的页面结构\"><a href=\"/zh-CN/docs/MDN/Writing_guidelines/Page_structures\">MDN Web 文档的页面结构</a></dt>\n <dd>\n <p>本节介绍了我们用于在 MDN Web 文档中提供一致的信息呈现的各种页面结构。包括：</p>\n <dl>\n <dt id=\"语法部分\"><a href=\"/zh-CN/docs/MDN/Writing_guidelines/Page_structures/Syntax_sections\">语法部分</a></dt>\n <dd>\n <p>MDN Web 文档中的参考页面的语法部分包含一个语法框，用于定义一个特性的确切语法。本文介绍了如何为参考文档编写语法框。</p>\n </dd>\n <dt id=\"代码示例\"><a href=\"/zh-CN/docs/MDN/Writing_guidelines/Page_structures/Code_examples\">代码示例</a></dt>\n <dd>\n <p>在页面上包含示代码示例的方法很多，本节介绍了这些方法，并提供了不同语言的语法指南。</p>\n </dd>\n <dt id=\"横幅和说明\"><a href=\"/zh-CN/docs/MDN/Writing_guidelines/Page_structures/Banners_and_notices\">横幅和说明</a></dt>\n <dd>\n <p>有时，在文章中需要添加特殊的说明。如果页面中包含不推荐使用的技术或不应在生产环境中使用的其他内容，则可能会包含这些特殊说明。本文涵盖了最常见的情况，以及应该如何处理它们。</p>\n </dd>\n <dt id=\"规范表格\"><a href=\"/zh-CN/docs/MDN/Writing_guidelines/Page_structures/Specification_tables\">规范表格</a></dt>\n <dd>\n <p>MDN Web 文档中的每一个参考页面都应该提供有关定义该 API 或技术的规范信息。本文演示了这些表格的外观，并说明了添加的方法。</p>\n </dd>\n <dt id=\"兼容性表格\"><a href=\"/zh-CN/docs/MDN/Writing_guidelines/Page_structures/Compatibility_tables\">兼容性表格</a></dt>\n <dd>\n <p>MDN Web 文档为我们的开放式的 web 文档提供了兼容性表格的标准格式。本文说明了为用于生成兼容性表格的数据库添加和维护数据，以及如何将这些表格集成到文章中。</p>\n </dd>\n <dt id=\"宏\"><a href=\"/zh-CN/docs/MDN/Writing_guidelines/Page_structures/Macros\">宏</a></dt>\n <dd>\n <p>宏是页面中用于生成内容（例如侧边栏）的较为便捷的方式。本节列出了我们使用的宏以及它们的作用。</p>\n </dd>\n </dl>\n </dd>\n <dt id=\"署名和版权许可协议\"><a href=\"/zh-CN/docs/MDN/Writing_guidelines/Attrib_copyright_license\">署名和版权许可协议</a></dt>\n <dd>\n <p>描述在其他地方使用 MDN Web 文档内容的政策、如何获得重新发布 MDN 上的内容的许可，以及链接到 MDN 上的内容的相关说明。</p>\n </dd>\n <dt id=\"如何标记一项技术\"><a href=\"/zh-CN/docs/MDN/Writing_guidelines/Experimental_deprecated_obsolete\">如何标记一项技术</a></dt>\n <dd>\n <p>本节涵盖了我们对过时、弃用和实验性术语的定义以及使用这些术语去标记一项技术的情形，并提供了关于何时从 MDN Web 文档中删除相应内容的指南。</p>\n </dd>\n</dl>"}}],"toc":[],"summary":"MDN Web 文档是一个开源项目。下面的概述部分描述了有关我们在 MDN Web 文档上撰写什么文档以及如何撰写文档的指南。学习如何做出贡献，请参见我们的贡献指南。","popularity":0,"modified":"2023-03-08T07:16:56.000Z","other_translations":[{"locale":"de","title":"Schreibrichtlinien","native":"Deutsch"},{"locale":"en-US","title":"Writing guidelines","native":"English (US)"},{"locale":"es","title":"Guías de escritura","native":"Español"},{"locale":"fr","title":"Règles d'écriture","native":"Français"},{"locale":"ja","title":"執筆ガイドライン","native":"日本語"},{"locale":"ko","title":"쓰기 안내서","native":"한국어"},{"locale":"pt-BR","title":"Sobre o MDN","native":"Português (do Brasil)"},{"locale":"ru","title":"Руководства по составлению документации","native":"Русский"},{"locale":"zh-TW","title":"關於 MDN","native":"正體中文 (繁體)"}],"pageType":"unknown","source":{"folder":"zh-cn/mdn/writing_guidelines","github_url":"https://github.com/mdn/translated-content/blob/main/files/zh-cn/mdn/writing_guidelines/index.md","last_commit_url":"https://github.com/mdn/translated-content/commit/d7ed8f60c9d2542f2709f623e2cdc9355bbcc8d1","filename":"index.md"},"short_title":"撰写指南","parents":[{"uri":"/zh-CN/docs/MDN","title":"MDN Web 文档项目"},{"uri":"/zh-CN/docs/MDN/Writing_guidelines","title":"撰写指南"}],"pageTitle":"撰写指南 - MDN Web 文档项目 | MDN","noIndexing":false}}</script></body></html>