Personal tools
You are here: Home 关于... CZUG社区 CZUG团队 文档和翻译团队 关于文档贡献说明
Document Actions

关于文档贡献说明

by 赵玉勇 last modified 2004-03-13 01:45

欢迎社区成员贡献翻译文章、原创文章。本文档说明了文档内容来源、贡献方法、内容与形式、文档的格式及内容要求、署名方法以及内容维护更新办法。

文档来源说明

文档来源从内容上可简单划分为 翻译原创指引 几类。

翻译、原创就不多说了,指引是一些有用的文档链接,全部翻译太麻烦,很多内容,只需要指点一下即可,采用现有的“链接”类型内容。

文档内容要求

限于Plone/Plone Products/Zope/Zope Products/Openflow相关的,一般包括以下内容:

  • 系统、产品的介绍文章
  • 系统产品的安装配置、操作使用说明
  • 系统某一方面功能特性(如zope的事务管理)的深入分析总结
  • ......

以上内容一般可以用于FAQ、HowTo、Book几种类型,其中Book是针对篇幅比较长、适合分章节编写的文档资料。

文档内容、格式要求

  • 内容及表达:观点明确,语言精练,条理清晰;
  • 保证文中的图片清晰;
  • 若参考了其他文献,则详细列出;
  • 对于翻译文章,须包括原文链接地址、原文作者信息,对于术语采用中文术语(原英文术语)格式。......

    czug文档翻译规范(暂无) 翻译文章样例(暂无)

  • 对于采用文档形式提交的,采用stx编写;对基于Wiki的,采用rstx编写。

    structure text 参考(暂无) restructure text(暂无)

  • 对于采用文档形式提交的,作者注意需要填写 描述 信息。
  • 对于Book类型文档资料,每章为一个单独的 "页面文档"。

    czug书籍编写规范(暂无)

文档提交方法

FAQ
FAQ基于Wiki搭建,成员可直接在Wiki中自行添加标题、自行编写完成。
HowTo
HowTo采用文件夹形式管理,成员可直接在该文件夹中添加 页面文档 类型内容,直接编写完成。

在编写过程中,负责人需要通过文档动态情况 及时公告进度情况、剩余工作情况。

在完成后,提交管理员审核发布。

发布后,作者如需修改文档内容,则需要收回,修改后再提交发布。

Book
成员可首先在文档翻译论坛中提出建议,根据大家讨论情况,管理员决定是否立项。

如果立项的话,管理员为该Book建立文件夹,赋予负责人管理权限,由该负责人独立负责完成Book编写。

根据情况需要,负责人可以再招募其它成员加入编写工作。

在编写过程中,负责人需要通过文档动态情况 及时公告进度情况、剩余工作情况

可采用collector管理进度?

作者权利义务

明确办法保障作者的权益,明确贡献文章与czug的关系。

作者的义务:及时维护更新内容

czug的权利义务

根据情况调整文章的维护人员、通知作者及时更新内容......


Powered by Plone CMS, the Open Source Content Management System

This site conforms to the following standards: