为Discourse撰写高效的文档

在有本地化文档的原生处理方式之前,我认为在标题前加上标志是处理它的最实用方法,并且是该指南的一个合理例外。

我认为这类事情有不同的意见和偏好,但对于这个风格指南,我们遵循公认的行业规范。再次强调,GoogleMicrosoft 的指南都同意使用常见的缩写更好。

话虽如此,我确实读过一些帖子建议使用否定缩写(如“can’t”)可能会让非英语母语者更难理解。我们将对此进行更深入的研究,并在必要时相应地更新风格指南。

我已经删除了那个例子! :smile:

是的——这很常见(不仅在 Discourse 中),但我同意这并不完全正确。使用引号会更好,所以我认为我会在风格指南中明确这一点。

这是一个很好的观点——我会在风格指南中加入这一点!

感谢您的反馈!@maiki 在上面提出了一些很好的观点,我同意他所说的。我想补充的是,我们已将官方文档切换为由 @Discourse 作为作者的原因之一是,为了让读者,特别是第一次接触文档的读者,感受到更大的权威性。这也是整个风格指南的初衷。

任何撰写文档的人当然仍然可以在他们的写作中注入个性,并且关于单个文档主题的讨论也不会消失,所以这总是一个让事情更具个性化的地方。

非常感谢所有这些反馈 :slight_smile:

2 个赞