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

2021-02-25 09:18:36 +08:00
 codists

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

一、不查证现象

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

二、随意参考的想象

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

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

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

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

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

2620 次点击
所在节点    程序员
23 条回复
Cielsky
2021-02-25 12:07:16 +08:00
百度百科你可以看下最下面的参考资料就知道宕机这个词条合适不。
感觉去查查最新的现代汉语词典更靠谱点吧。
Slartibartfast
2021-02-25 12:20:43 +08:00
@codists 那举一个词典收录宕机的例子?

宕机本来就是口语词汇,这几年逐渐出现在很多不严谨的场合,但是严肃的计算机专业教材上没有引用。

未来有可能会有,但是至少到目前为止还不是专业词汇。

此外如果把宕机局限于单台服务器故障,我是认同的,但是延伸出什么网站宕机,简直胡扯
godgc
2021-02-25 16:06:42 +08:00
严谨有严谨的乐趣,反思有反思的益处,没啥好再多探讨的哦,说的多了就过度解读了

这是一个专为移动设备优化的页面(即为了让你能够在 Google 搜索结果里秒开这个页面),如果你希望参与 V2EX 社区的讨论,你可以继续到 V2EX 上打开本讨论主题的完整版本。

https://www.v2ex.com/t/756042

V2EX 是创意工作者们的社区,是一个分享自己正在做的有趣事物、交流想法,可以遇见新朋友甚至新机会的地方。

V2EX is a community of developers, designers and creative people.

© 2021 V2EX