Dorado 5 : 1.2文档内容概述 (T22)

文档产生原因

Bstek的产品Dorado提供了一个Dorado示例中心,即Dorado Sample Center,用来给客户展示Dorado的功能以及性能。用户对Dorado有了一定的了解之后,可能会对Dorado Sample Center中的某一个页面是怎么做出来的很感兴趣。如果查阅《Dorado 5 用户指南》和《Dorado 5组件详解》文档,则会花费相当多的时间。为了方便用户快速了解Dorado Sample Center中页面的的开发,所以构建了这份文档。

文档内容范围

Dorado Sample Center包含了大量的页面,有些页面仅仅是为了展示Dorado的性能的,一般用户不会去在实际项目中开发这种页面,这份文档将不会包含这部分页面。

文档阅读群体

该文档适合于Dorado的初学者且对Dorado Sample Center的某些页面的实现有兴趣的技术人员的自学,也可用于正式的教学。

文档结构

前两章为文档的介绍以及准备工作,没有固定的结构。
从第三章开始,每个章节分为概述、准备工作、开发步骤、知识点四个部分。每个部分的内容为:

部分

内容

概述

内容为该文档的内容的概述,一般会描述一下该页面的结构和在Sample Center中所在页面等。

准备工作

内容一般为开发环境的准备,包括Dorado Studio、数据库等。

开发步骤

内容一般为开发这个页面的具体步骤,会包含一系列的步骤和截图。

知识点

内容一般为对这个页面开发过程中的难理解的地方的解释,还会包含可以深入了解的文档。

文档风格

在结构方面来说:该文档为Step By Step教程,所以章节结构会很死板,我们认为这样可以使用户对开发一个页面的过程有明确的了解。
在内容方面来说:为了避免用户对语句关系上的误解,大部分语句采用简单的祈使句。关于Dorado中的术语,全部采用英文单词,不使用中文名。因为每个人的翻译习惯不同,避免用户对Dorado术语的误解。在开发步骤部分,会包含操作步骤和少部分的解释。操作步骤就是按照实际开发中开发顺序的来的,包含有步骤1、步骤2这种提示说明,操作步骤比较复杂的会有截图。知识点会大体讲一下难点或者是需要注意的地方,然后给出可以参考的文档。

特殊说明

按照文档中步骤来生成的页面可能与官方网站上的示例中心的页面内容不完全相同,但是页面的效果以及知识点可以保证是完全相同的。
该文档附带所有章节工程文件,按照每个章节来进行分类的。