编写或修改 Yii 文档时的指导方针。
This needs to be expanded.
- 尽量使用积极向上的语气。 Try to use an active voice.
- 用简短精炼的语言。 Use short, declarative sentences.
- 尽量多用代码举例说明你的思想。 Demonstrate ideas using code as much as possible.
- 不要使用“我们”这个字眼，这个字眼是代指 Yii 开发团队或 Yii 核心团队的。最好用“该框架”，“该指南”这样的字眼来阐述。 Never use "we". It's the Yii development team or the Yii core team. Better yet to put things in terms of the framework or the guide.
- 用牛津逗号（比方说，“这儿，那儿，和其他”而非“这儿，那儿和其他”）。 Use the Oxford comma (e.g., "this, that, and the other" not "this, that and the other").
- 顺序列表都应该表现为完整的句子，并以句号（或其他符号）终结。 Numeric lists should be complete sentences that end with periods (or other punctuation).
- 无序列表应该表现为片段，且不要用句号。（译者注：是这样么？你自己都不是这样的吧喂）Bullet lists should be fragments that don't end with periods.
块状引用使用了 > Type: 的 Markdown 语法。这里有四种不同的类型：
Warning，译为警告，用于点出不安全的事物或其他的隐患Note，译为注意，用于强调核心概念，或是需要避免的事情Info，译为补充，一般的信息（题外话）；重要性上不如注意事项严重Tip，译为小技巧，专业的建议以及补充，可能会很有用，但是可能不是所有人每时每刻都需要他
- Yii 2.0 或 Yii 2 （不是 Yii2 或 Yii2.0）
- 指南的每一页都以 “section” 方式表达（译者：把每页称为一章节）。
Web，而不是webthe guide或this guide而不是the Guide