Difference: AuthorReadme (24 vs. 25)

Revision 252019-05-02 - TangZhicheng

Line: 1 to 1
 


校园宇宙线计划文档编写说明

这是项目文档的编写说明。

情况介绍

目前,网站上包含许多具有文字介绍性质的页面,为了方便所里同事们编写修改,每个页面都对应的在twiki上有一个页面。大家在twiki上编写修改,内容定期同步到网站上,这样既方便又不易出错。

TWiki是一种十分适合于多人写作编写文档的平台,每个用户都可以在现有文档的基础上修改,所有的改动都可以追溯,既方便又安全。

Changed:
<
<
TWiki的使用可以参考 TWiki/WebHome
>
>
TWiki的详细使用可以参考 TWiki/WebHome,这里只简单介绍一下最基本的步骤:
  1. 在页面右上角的“ 账户”菜单里选择“ 登录”或者“ 注册”,注册只需要简单地填写邮箱等信息并确认即可。
  2. 在要修改的页面右上角的“编辑”按钮,进入可视化编辑状态
  3. 使用工具栏进行编辑修改,并在结束时点击左下角的“保存”按钮
    • 如果编辑有误不要紧,可以再次编辑改正,短时间内的几次编辑只会保留最后一次的结果
    • 编辑以后或者之前最好在邮件组或者用微信群等其他方式通知大家
 

编写说明

为了尽量保持文档可读性,请遵循以下编写指南:

  1. 保持文档精简:单个文档不宜太长,尽量保持在两页以内,更详细的内容请单独起一篇文档,在主文档中只简略介绍。
  2. 保持结构精简:除了文档长度,过多的标题结构也会影响可读性。twiki中提供了6个级别的标题可供使用,但是相互之间阅读区分性并不好。建议同一篇文档中只使用3以内的标题。
  3. 言简意赅,尽量使用表格、分行、分段等结构性的写法,避免过长段落。

页面列表

Changed:
<
<
目前网站页面包含首页、简介、图集、数据列表、使用说明等页面。其中除了图集和数据列表外都是文字介绍为主,在twiki上放置了对应的页面。
>
>
目前网站页面包含首页、简介、图集、数据列表、使用说明等页面。其中除了数据列表外都是文字介绍为主,在twiki上放置了对应的页面。
 

首页

首页是关于网站的简短介绍。

twiki页面: WebsiteFrontpage

简介页

简介页包含大部分的介绍信息。目的是使新成员在阅读以后了解整个校园宇宙线计划的目的、意义,以及进一步的阅读资料

twiki页面: CRACIntro

Added:
>
>

图集页

这一页面计划放上一些代表性的图片,包括统计信息和事例显示等

twiki页面: WebsiteGallery

 

使用说明页

用于介绍数据平台的具体使用方法,包括原始数据下载、数据处理软件使用、网站图集解释等等。

twiki页面: CRACDocumentation

自我介绍页

用于自我介绍。

twiki页面: WebSiteAbout

-- Tang Zhi-Cheng - 2019-01-28

Comments

<--/commentPlugin-->

META TOPICMOVED by="tangzc" date="1556441583" from="CRAC.AuthorReadMe" to="CRAC.AuthorReadme"
 
This site is powered by the TWiki collaboration platform Powered by PerlCopyright © 2008-2019 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback