美文网首页
文档撰写规范

文档撰写规范

作者: A小团子 | 来源:发表于2018-08-10 10:55 被阅读0次

    一、命名规范

    1. 文件命名规范

    项目命名词(或项目编号)_文件命名词_日期_V版本号.文件后缀

    项目_文件描述_当前日期_阶段标识.文件后缀

    例如:Doc_PCPISProposal_20101112_V1.0.doc 如果是同一版本同一阶段的文件修改过两次以上,则在版本标识后面加以数字标识,每次修改数字加1 当有多人同时提交同一份文件时,可以在版本标识的后面加入人名或缩写来区别。

    2. 文件夹命名规范

    文件夹名称_日期_日期。

    例如:Prj_PCPISProject_20101112_

    ?第二个下划线后为空,等待工作结束时,添加工作结束的日期。

    特殊标识不同状态的文件:

    1)、!(叹号)——标注重要的文件或者文件夹

    2)、#(井号)——标注等待处理的文件或者文件夹

    3)、@(@号)——标注正在处理的文件或者文件夹

    3. 文档版本号规范

    版本号内容包括版权所有和版本号两部分

    示例:

    Copyright © 1998 - 2018 Tencent.All Rights Reservedc

    VersionDateAuthorReviewDescription

    v1.02018-01-03张三李四第一版

    v2.02018-09-03张三王二修改了XX

    二、字体颜色规范

    注意:除代码块内文字可更改颜色(请使用html标准颜色如red\blue等),其余规范均不可更改。

    正文中文字体微软雅黑(PC) 苹方(Mac)

    英文字体PingFangSC-Light字集(苹方

    字体颜色#666

    字号色14px(五号)

    代码块/文本中的代码英文字体体Consolas字集)

    默认字体颜色#666(可更改)

    背景颜色#F7F7F7)

    标题中文字体微软雅黑(PC) 苹方(Mac))

    字体颜色#000

    字号色不等,见下文“标题/列表规范”。

    三、标题/列表规范

    1. 文档标题有形如下的格式规范,目录从一级开始,最多可到第三级。(三级以上的标题不符合常规阅读需求,请拆分或使用标题内的列表进行相应处理)

    标题层级显示样式Markdown语法

    第一级标题## 第一级标题Markdown请注意采用二级‘##’语法,对应Word字号为22.5

    第二级标题### 第二级标题Markdown请注意采用三级‘###’语法,对应Word字号为17.5

    第三级标题#### 第三级标题Markdown请注意采用四级‘####’语法,对应Word字号为13

    2. 内容列表有形如下的格式规范:

    列表层级显示样式

    正文第一级列表1. 列表项一 

     2. 列表项二

    列表中的第二级列表1. 列表项一

    这是一段说明

    1) 二级列表项一

    2) 二级列表项二

    二级列表中的第三级列表1. 列表项一

    这是一段说明

    1) 二级列表项一

    这是另一段说明

    A. 三级列表项1

    B. 三级列表项2

    2) 二级列表项二

    四、内容规范

    1. 公司及产品名称

    我们的公司及产品名称是「DaoCloud」。注意这是两个单词的合成词,所以中间沒有空格(参考:GitHub)。如作为 URL 的一部分,应该使用全小写的「daocloud」。

    2.文案风格

    一定多检查,确保没有错别字。

    即使是流行语中的谐音错别字也不要使用,比如「墙裂」、「童鞋」等。

    我们崇尚精练的文风。请在检查中把对表达意思没有明显作用的字、词、句删除,在不影响- 表达效果的前提下把文案长度减到最短。

    记住,如果你写了一条文案觉得非常聪明非常好笑,很可能需要停下来想一下用户是否能理解。(本条感谢 37signals 的文案建议)

    3. 中文、英文、数字混排时空格的使用

    英文与非标点的中文之间需要有一个空格,如「使用 DaoCloud 自动构建和部署」而不是「使用DaoCloud自动构建和部署」.

    数字与非标点的中文之间需要有一个空格,如「我们发布了 5 个产品」而不是「我们发布了5个产品」。 正确:「这是 1 款 Android 应用」,错误:「这是1款Android应用」。 正确:「2014 年 2 月 14 日」,错误:「2014年2月14日」。

    尽可能使用中文数词,特别是当前后都是中文时。上面的例子写为「我们发布了五个产品」会更好。

    除了「%」、「°C」、以及倍数单位(如 2x、3n)之外,其余数字与单位之间需要加空格。

    注意特殊名词的大小写:Android、iOS、iPhone、Google、Apple,无论是否在句首都应该以同样的方式写。

    在官方文案中尽量使用中文,避免中英文混合的情况。例如「App」一般应写为「应用」或「移动应用」。品牌、产品名、人名、地名等特殊名词,如果来自英文,请使用英文以避免在不同译法之间选择。

    4. 标点相关

    只有中文或中英文混排中,一律使用中文/全角标点。

    中英文混排中如果出现整句英文,则在这句英文中使用英文/半角标点。

    中文标点与其他字符间一律不加空格。 正确:「有:Apple、Android、诺基亚」错误:「有:Apple 、 Android 、 Nokia」

    中文文案中使用中文引号「」和『』,其中「」为外层引号。Mac 上如「百度输入法」等都可以方便地输入中文引号。

    省略号请使用「……」标准用法,不要使用「。。。」 ,也不要使用三个英文句点「.」。

    感叹号:请勿使用「!!」。尽量避免使用「!」。请先冷静下来再坐电脑前敲键盘。

    波浪号:请勿在文章内使用「~」,活泼地卖萌有很多其他的表达方式。

    5. 段落

    如果是纯文本,段落之间使用一个空行隔开。如果是 HTML 或其他富文本格式,使用额外空白作为段落间的分隔。

    段落开头不要留出空白字符。

    6. 引用来源

    如果在正文中部分引用第三方内容,请使用恰当的引用格式并注明出处。如: One man’s constant is another man’s variable. — Alan Perlis

    如果是全篇转载,请在全文开头显著位置注明作者和出处,并链接至原文,如: 本文转载自 WikiQuote

    如果格式不允许超链接,请以文本方式直接给出原文链接。如果原文链接太长影响美观,可以使用短链接服务。如: 本文转载自 WikiQuote:http://bit.ly/UlHIdN

    文中有使用外站图片,必须在文末标明。来源如果来自外站必须添加链接,来源如果来自外部作品则不需要。如:「本文部分图片来自 ifanr」「题图来自:《春娇与志明》截图」。

    若文章为全文翻译,必须在注明作者和出处,并链接至原文。

    若文章为部分编译,则需在文末注明作者和出处。如:「本文部分内容编译自 Apple」「本文部分观点来自煮机网微博」。

    7. 细节问题

    「你」和「您」:在不是很正式或没有明确的个体指代对象的时候请用「你」,如文档、博客、群发的邮件等;在指代特定个体时请用「您」,如活动邀请函等。 自我称呼:使用「我」,不推荐使用「小编」、「笔者」、「兼职编辑」、「兼职作者」自称。

    字体和字号的一致:在富文本格式文档中,特别是 HTML 邮件中,常有人因为从不同来源复制粘贴而导致同一层次的文本字体和字号不一致。这给人不专业的感觉,请避免。

    App 是 application 的缩写,发音为 /ˈæp/,所以要注意不要把三个字母拆开念。App 是一个普通名词而不是多个单词的首字母缩写,所以不应该用全大写的 APP。和其他词一样,大小写规则取决于是否处于句首、标题、或特殊短语(如 App Store)中。大多数情况下应该使用中文「应用」以避免这样的问题。

    8. 遣词造句

    用主动语态,不要用被动语态。一般情况下,主动语态比被动语态更有力。

    使用具体、明确、展示细节的词汇,能激发想象,使读者自己代入情境。「把硬币放进口袋里,他咧开嘴笑了」,远远强过「他满意地拿走了辛苦挣来的奖赏」。

    减少形容词的使用,少用 「的」。

    「的」「地」「得」要用对。是的,连小学都不要求了但是要用对。

    9. 文章引言

    章引言非常重要。它的作用主要是用于网站首页展示和微博分享,它是为了吸引读者阅读文章而存在,它的目的是让读者能够仅通过这一小段话,就能迅速了解到这篇文章的大致内容。因此,引言实际就是文章的「内容概要」,而非文章的开头首段。 我们建议通常在写完整篇文章后,再结合内容大纲撰写引言。引言务必要讲清两个问题:

    是什么?(例如:这是一款什么应用?这篇文章是讲的什么?)

    为什么?(例如:这款应用之所以被推荐,是由于它有哪些特色/亮点?)

    引言的语言文字务必要清晰、直观、简洁,通常字数需控制在 90 字左右。

    10. 一些常用名词的正确用法

    App / 应用(错误:APP、软件、程序)

    Android(错误:android、安卓)

    iOS(错误:ios、IOS)

    iPhone(错误:IPHONE、iphone)

    App Store(中间有空格,错误:AppStore、app store)

    WiFi(错误:wifi、Wifi、Wi-fi)

    email (错误:E-mail、Email)

    账号(错误:帐号,账户,帐户) [http://www.jianshu.com/p/baa85caede21] - - - - 苹果台湾用「帳號」,大陆用「账户」 谷歌用「帐户」,百度用「帐号」

    登陆(错误:登录)

    P.S. (错误:PS、ps、Ps.)

    相关文章

      网友评论

          本文标题:文档撰写规范

          本文链接:https://www.haomeiwen.com/subject/imapsftx.html