参与文档编写
GDevelop 的文档由社区驱动,欢迎每个人贡献。
要提交对 Wiki 中任何现有页面的更改,请按照以下步骤完成:
- 浏览要编辑的 Wiki 页面。
- 在页面右上方,单击 Edit this page 按钮。
- 它会显示为纸和铅笔图标。!
- 单击 Fork this repository。这只需做一次。
- 使用 GitHub 提供的在线文本编辑器进行更改。请确保遵循下面列出的准则。
- 在 Propose Changes 部分中添加对更改的简短描述。
- 单击 Propose Changes 按钮。
- 单击 Create pull request。
- 单击 Create pull request。
现在由文档团队审查和批准更改。感谢您为改进 GDevelop 文档做出的贡献!
文档标准和最佳实践
本页的其余部分提供了一些建议,以帮助保持文档质量。
保持一致性
查看现有文档并遵循已建立的模式。在内容的结构、格式和写作方式方面不要试图重复造轮子。
简洁
使用简单的语言、简短的句子和更少的词语。如果不确定您的写作是否太啰嗦,请使用像 Hemingway 这样的工具进行检查。
专业
友好的语气写作,但不要过分。如果太随便,读者可能会觉得难以阅读或信任。
创建各种文档类型
有三种类型的文档:
- 概念 - 解释某事物是什么。
- 任务 - 解释如何做某事。
- 参考 - 提供事实列表,没有(很多)解释。
一般来说,最好不要在单个页面上混合不同类型的文档。例如,不应该在一篇页面中提供关于 表达式是什么 的详细解释(参考)。
撰写清晰、行动导向的标题
读者倾向于浏览页面,因此清晰的标题至关重要。读者也倾向于关心完成特定任务,所以标题应侧重于行动。
使用 Markdown
Markdown 是一种用于在网络上格式化文本的语法。它简单、易学,并且能够让我们在不同的发布平台之间移动内容(如果必要的话)。
提示:
不要使用特定于 Wiki 软件的功能,比如 WRAP
标签。
引用按钮、对象、行为等时
如果您直接引用出现在应用程序中的内容,无论是按钮、选项卡名称、条件/动作等,您应该将其加粗显示。这表明您正在确切引用其名称,尤其是从一份指令的编号列表中。
在结构或写作方法上有疑问时,请遵循样式指南
有关文本格式(加粗、创建列表等)的语法问题,请参考 Wiki 语法。
如果不确定如何书写某事物或显示步骤的最佳方法,请参考 Google 开发者文档风格指南。这仅用于文档风格最佳实践,语法应遵循上方的链接。这是一份详尽的指南,您不必记住所有内容,但它作为参考非常有用。