forked from pi-engine/pi
-
Notifications
You must be signed in to change notification settings - Fork 0
Doc.Documentation Format
Taiwen Jiang edited this page Jul 5, 2013
·
4 revisions
- Naming conventions
- All page names should be in Camel case
- Page names should be started with a leading prefix, for instance
Dev.Module Structure
Dev.
Tutorial.
-
Adding A New Documentation
- The documentation list page must prefix with
Doc.
and suffix with language abbreviation, for example: Doc.Pi Documentation List.en - The link of documentation list page should be added in Documentation of Different Language section of Pi Documentation Team page
- New documentation must prefix with its type, if language is not English, it need to suffix with language abbreviation
- Module development documentation prefix with
Dev.
- Module development tutorial prefix with
Tutorial.
- Front-end development prefix with
Front.
- User manual prefix with
Manual.
- For example: Dev.Module I18n
- Module development documentation prefix with
- New documentation title must be added to Pi Documentation List page, and be added following information:
- If the documentation language is not English, an English version link must be added at first line of the documentation, such as
- When achieves documentation, deleting the by *** information, and changing the status to
For review
- The documentation list page must prefix with
- Reviewing Documentation
-
添加新文档
-
documentation list页必须添加
Doc.
前缀,同时添加该语言的缩写作为后缀,例如: Doc.Pi Documentation List.zh-cn - Documentation list页的链接要加到 Pi Documentation Team 页面的 Documentation of Different Language 项
- 新增文档必须将其类型作为前缀,如果文档非英文,同时需要添加该语言的缩写作为后缀
- 模块开发文档前缀为
Dev.
- 模块开发教程前缀为
Tutorial.
- 前端开发文档前缀为
Front.
- 用户手册前缀为
Manual.
- 例如:Dev.Module I18n.zh-cn
- 模块开发文档前缀为
- 新文档的文档名必须加到 Pi Documentation List 页,同时需要在文档名后添加如下信息:
- 如果该文档不是英文,其对应的英文文档的链接需要加到文档的第一行,如
- 当完成文档,需要删除by ***信息,同时将状态修改为
待检查
-
documentation list页必须添加
- 检查文档