用户指南标题的大写规则

by ClickHelp —最佳的技术写作工具

似乎大写变成了一个问题。 如果您查看多个网站,您会看到相同的单词以不同的方式大写。 我的意思是,是Microsoft还是MicroSoft? 还是我们只是写Microsoft并称之为一天?

一些用户指南将标题中的每个单词都大写,另一些省略介词,而另一些则采用经典的用法:将第一个单词和专有名词大写。

问题是,从语法的角度来看,有很多文章都集中在大写字母上,但是当涉及到技术写作时,信息却相当缺乏。

为什么这甚至是东西?

在公司创建技术文档时,他们可能倾向于使用大写字母表示要突出显示的内容,因为它们非常重要。 这种方法的问题在于它没有提供一致的样式,从而使用户手册显得草率且不专业。

这也使文档更难以阅读。 大写字母不是技术作家用来强调一个想法的风格方法。 更不用说,过多的大写字母可能会分散注意力。 如果要引起对某个想法的注意,则应使用斜体或特别注意。

大写准则

正如您可能已经发现的那样,大写可能会有些混乱。 许多技术作家很难弄清楚他们应该大写什么字母以及什么时候大写。

因此,请牢记以下几条规则:

  • 包含四个或更多字母的单词,无论它们在标题中的位置如何。
  • 无论标题的长度或词性如何,请始终将标题的第一个单词大写。 它也适用于字幕。
  • 始终大写标题的最后一句话。
  • 冠词(the,a,an)或短介词(at,to,in,off,up,for,by,for)的连词(so,and,but,or,but等)不应大写。 演讲的其他部分也应如此。

本质上,您的标题的大部分单词都大写(除少数例外),而副标题的行为就像普通句子一样。 这样,字幕将具有第一个单词的大写字母和专有名词(如果有的话)。

技术作家可能面临的最大困难是,决定如何处理诸如“一个”,“是”,“它”,“自己的”,“他的”或其他单词之类的简短单词。 除非它们是连词,冠词或短介词,否则无论其在标题中的位置如何,都必须将这些短词大写。

一切都与风格有关

当然,有些人可能会考虑此问题,并认为在制定文档计划时它的重要性较小。 但是,考虑到您的用户指南很可能具有各种标题和副标题,因此技术作家需要重点关注使读者更轻松地浏览文档的过程。

您可以在我们最近的这篇文章-如何编写用户文档和帮助手册中了解有关如何计划此权限的更多信息。

为每个部分明确建立的样式不仅使您的材料看起来更加专业,而且还帮助用户轻松使用它。 正如您重新阅读材料以确保内容在语法上正确一样,您也应该对大小写相同。

现在,拼写检查器已集成在许多帮助创作工具的文本编辑器中,但大写字母的检查并不容易。 因此,您有责任在团队中散布这些规则,并使技术文档看起来更加专业。

祝您技术上写好运!
ClickHelp小组