Tags:
create new tag
view all tags

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

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

情况介绍

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

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

TWiki的使用可以参考 TWiki/WebHome

编写说明

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

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

页面列表

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

首页

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

首页的twiki页面: TestCRACFrontPage

简介页

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

简介页的twiki页面: TestCRACIntro

使用说明页

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

使用说明页的twiki页面: TestCRACDocumentation

自我介绍页

用于自我介绍。

twiki页面: TestCRACAbout

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

Comments

这一页改为所内成员使用须知,介绍网站和twiki关系,以及编写twiki的说明

-- Tang Zhi-Cheng - 2019-02-22

Topic attachments
I Attachment History Action Size Date Who Comment
HTMLhtml datalist.html r2 r1 manage 196.8 K 2019-02-18 - 09:40 TangZhicheng sample of the data list page
HTMLhtml draft.html r9 r8 r7 r6 r5 manage 2.2 K 2019-02-18 - 08:01 TangZhicheng draft of the website front page
Edit | Attach | Watch | Print version | History: r18 < r17 < r16 < r15 < r14 | Backlinks | Raw View | Raw edit | More topic actions
Topic revision: r18 - 2019-02-25 - TangZhicheng
 
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