Revision as of 06:54, 19 December 2012

Documentation

Describe the purpose or context at the begining.
To start from a basic, simple concept or fewer concepts.
1 paragraph presents 1 idea.
Give the overall concept first, then the detail of implementation.
Summary at the end. (for small talk)
Check header, footer, TOC, subsections, references
Check overall article's layout.
Picture is better than words.
1. Picture should be elegant.
2. Picture should present just exactly enough information.
3. Set align to center.
Code snippet:
1. Focus on a general case not a specific one.
2. Keep as short as possible.
3. Demonstrate only key concepts and remove irrelevant and unused ones.
4. Demonstrate the correct API usage.
5. Keep number of code examples as fewer as possible to reduce readers' burden.

Standard:

Note: note message

Deprecated:

[i] Note: note message

Warning: warning message

Not Work sample:

/_w/images/e/e2/Icon_info.png

Revision as of 02:51, 19 December 2012 (view source) Hawk (talk \| contribs) (→‎Under Editing) ← Older edit		Revision as of 06:54, 19 December 2012 (view source) Hawk (talk \| contribs) (→‎Under Editing) Newer edit →
Line 5:		Line 5:
	[http://books.zkoss.org/wiki/ZK_Developer%27s_Reference/MVVM/Advance/Displaying_Huge_Amount_of_Data Displaying_Huge_Amount_of_Data]		[http://books.zkoss.org/wiki/ZK_Developer%27s_Reference/MVVM/Advance/Displaying_Huge_Amount_of_Data Displaying_Huge_Amount_of_Data]

		+	[[User:Hawk/Collection_and_Selection]]