关于《“宕机”一词在技术文档中如何表达？》的一点思考

说明：本主题无意于争吵，只是对原主题中的一些现象进行讨论。原主题详见：“宕机”一词在技术文档中如何表达？。

一、不查证现象

作者在原主题中写到“但是我感觉“宕机”一词，像是口语。”。根据百度百科中宕机的定义：宕机是计算机术语。所以“宕机”隶属于计算机专业术语，而不是口语。但凡作者搜索下该词，就不会说出这种“我感觉”，“我觉得”之类的话。当然，这里并不是要指责作者，而是指责这种根据感觉来的，随意的现象。尤其是在技术文档写作中，更不应该出现。

二、随意参考的想象

作者在原主题中提到《中文技术文档写作风格指南》。上一个问题是不参考，而这个问题属于随意参考。不得不说，这份指南的问题很多。如 @geelaw 就指出了一个。我们再来看看其它的问题：

（ 1 ）在“关于本指南”一节，作者使用了英文 Contents 代替“目录”之意，明显是不妥当的。

（ 2 ）在“语言风格”——“简洁清晰”一节，作者提到“尽量用主动时态，尤其要阐述清楚主语和宾语”。时态怎么会有主动被动呢？只有语态才有。

（ 3 ）在“名称与命名”——“文件命名”一节，作者将“-”称为“短划线”。短划线是中划线，还是下划线呢？这里明显也是不妥当的，应该称为“中划线”。

对于这样一份错误百出的文档，我们实在不应该将其作为参考文档。个人认为，选择参考文档时可以考虑一些组织级别或者公司级别的规范，如 daocloud 公司的写作规范和格式规范。少选择个人撰写的规范。如果要选择个人撰写的规范，建议尽量选择长期深耕该领域的人员所撰写的，如阮一峰的中文技术文档的写作规范。

codists

2021-02-25 10:41:19 +08:00

@czfy
你好，是这样的：
1 、针对大佬提的第一个问题。这里不是说在学术论文里引用，也不是说在商业等业务场景引用百度百科。我的意思是我们在写文档的时候要查证，百度百科只是举例，也可以查维基百科，也可以查书籍，以及其它资料等等。重点是要查证，而不是凭感觉，也不是就完全相信所查找资料的内容。
2 、针对大佬提的第二个问题。我的意思在中文文档中，contents 可以翻译成目录，但是作者依然在中文文档中使用的是英文，不恰当。不是说用 contents 表示“目录”错误。希望没有给你带来无解。