Difference: AuthorReadme (27 vs. 28)

Revision 282020-01-29 - TangZhicheng

Line: 1 to 1
 


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

页面列表

 
This site is powered by the TWiki collaboration platform Powered by PerlCopyright © 2008-2020 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback