Loading...
 

DocConventions

Old documentation

If you want to learn how to document for Tiki, you probably want to work for Polaris on doc.tikiwiki.org, which has it's own conventions page : Formatting Standards
This page could still be useful as a supplement. Start by reading Formatting Standards and see if you can add content to it if something written here is missing there.

Old content

How to Document a Feature

To document a feature correctly, the documentation team needs to create a range of pages, including a ))FeatureXGlosspage (defining the feature), aFeatureXpage that lists what the feature can do, aFeatureXDocspage with step-by-step instructions, aFeatureXAdminpage with step-by-step administrative procedures and tips, and aFeatureXSettings(( page that provides a quick overview of the feature's administrative settings. For more information and examples, click the plus sign.

[+]

How To Write Great Documentation

It's easy — just follow a few simple rules. The following guidelines are suggested for ))FeatureXDocandFeatureXAdmin(( pages. Click the plus sign to view the guidelines.

[+]

Annotated Example

Click the plus sign to see some documentation that implements the guidelines (presented above).

[+]

Documentation Conventions

For consistency's sake, typographical conventions — formatting rules to follow when writing documentation — make very good sense. Click the plus sign to view the recommended conventions.

[+]

Newest Forum Posts

  1. Tue 25 Apr 2017 09:17 CEST, by ujydlnro1124 - Tiki and PluginR">真实认证!【QV:597563720】专业办理加拿大温哥华社区学院毕业证、成绩单、使馆留学回国人员证明、教育部官网可查、录取通知书、Offer、在读证明、雅思托福成绩单、网上存档永久可查!100%通过
  2. Tue 25 Apr 2017 09:17 CEST, by ujydlnro1124 - Tiki and PluginR">真实认证!【QV:597563720】专业办理加拿大希尔克学院毕业证、成绩单、使馆留学回国人员证明、教育部官网可查、录取通知书、Offer、在读证明、雅思托福成绩单、网上存档永久可查!100%通过
  3. Tue 25 Apr 2017 09:16 CEST, by ujydlnro1124 - Tiki and PluginR">真实认证!【QV:597563720】专业办理加拿大西北社区学院毕业证、成绩单、使馆留学回国人员证明、教育部官网可查、录取通知书、Offer、在读证明、雅思托福成绩单、网上存档永久可查!100%通过
  4. Tue 25 Apr 2017 09:16 CEST, by sdzewdzssawe02 - Español"> {亚利桑那州立大学ASU毕业证文凭办理,成绩单办理】Q/微869520616学历认证办理,美国毕业证文凭办理 ArizonaState University
  5. Tue 25 Apr 2017 09:16 CEST, by ujydlnro1124 - Tiki and PluginR">真实认证!【QV:597563720】专业办理NLC办理加拿大北极光学院毕业证、成绩单、使馆留学回国人员证明、教育部官网可查、录取通知书、Offer、在读证明、雅思托福成绩单、网上存档永久可查!100%通过
  6. Tue 25 Apr 2017 09:16 CEST, by ujydlnro1124 - Tiki and PluginR">真实认证!【QV:597563720】专业办理加拿大北岛学院毕业证、成绩单、使馆留学回国人员证明、教育部官网可查、录取通知书、Offer、在读证明、雅思托福成绩单、网上存档永久可查!100%通过
  7. Tue 25 Apr 2017 09:15 CEST, by ujydlnro1124 - Tiki and PluginR">真实认证!【QV:597563720】专业办理加拿大兰加拉学院毕业证、成绩单、使馆留学回国人员证明、教育部官网可查、录取通知书、Offer、在读证明、雅思托福成绩单、网上存档永久可查!100%通过
  8. Tue 25 Apr 2017 09:14 CEST, by ujydlnro1124 - Tiki and PluginR">真实认证!【QV:597563720】专业办理加拿大道格拉斯学院毕业证、成绩单、使馆留学回国人员证明、教育部官网可查、录取通知书、Offer、在读证明、雅思托福成绩单、网上存档永久可查!100%通过
  9. Tue 25 Apr 2017 09:14 CEST, by ujydlnro1124 - Tiki and PluginR">真实认证!【QV:597563720】专业办理加拿大洛矶山学院毕业证、成绩单、使馆留学回国人员证明、教育部官网可查、录取通知书、Offer、在读证明、雅思托福成绩单、网上存档永久可查!100%通过
  10. Tue 25 Apr 2017 09:14 CEST, by ufd88hhh - Tiki and PluginR">(留学办理)华威大学毕业证,@Q微信2516986537 Warwick文凭,Warwick学历认证制作(offer)成绩单电子图+《录取通知书&在读证明》教育部学历认证 University of Warwick

Why Register?

Register at tiki.org and you'll be able to use it at any *.tiki.org site, thanks to the InterTiki feature. A valid email address is required to receive site notifications and occasional newsletters. You can opt out of these items at any time.