Revision as of 09:28, 1 June 2016

About Me

Documentation

Under Editing

What is the maximal rows and columns ZSS supports?

ZSS renders cells on demand instead of rendering all cells at once in a browser, but it loads a file's whole content into the memory. So the bigger memory your server has, the more rows and columns ZSS can load.

But even if you have sufficient memory, loading time could be an issue. Because loading time grows linearly with cell number. Under our test machine, loading 1 million cells with texts takes 65 seconds, loading 2 million cells takes 139 seconds and loading 4 million cells takes 315 seconds. As the cell number grows, the time could be too long to be acceptable by users. You can measure the loading time on your machine first.

Under Review

Ready for Publish

User:Hawk/Integrating_ZK_with_Angular

Suspend

Already published

Technical Writing

My Practice of Writing Documents

Preparation :

list assumptions for readers. To know which knowledge base which you build on and to decide which content the document should have.
write outline first.
to be reviewed and discuss in bird's eye view

check order of topic should have logical dependency
Pre-write quickly first.
need a technical proofreader to check technical concept
need an editor to check grammar and style.
Arrange topics with logic dependent orders, but leave some clues for those readers who skim a document
1. Title
2. Bold text
3. Pictures
4. Code highlight

Writing:

Topic sentence first, then supporting sentences
Describe the purpose or context at the beginning.
To start from a basic, simple concept or fewer concepts.
1 paragraph presents 1 idea.
overall concept first, an example, then technical detail
keep consistent style in code or describing way in multiple related articles
keep consistent wording or terminology.
Summary at the end. (for small talk)
Choose Active, Precise Verbs
Check header, footer, TOC, subsections, references
Picture is better than words.
1. Picture should be elegant.
2. Picture should present just exactly enough information.
3. Set align to center.
4. Shrink size if a picture's width is wider than page width.
Code example:
1. Re-using same application as an example. It can reduce user's burden to realize your article.
2. Focus on a general case not a specific one.
3. Keep as short as possible. Just extract the key part
4. Demonstrate only key concepts and remove irrelevant codes.
5. Demonstrate the correct API usage instead of work-around
6. Keep number of codes as fewer as possible to reduce readers' burden.
7. Highlight key points in descriptions of code example. (Because most engineers read code first instead of text)
8. give short description for a code snippet for its purpose
9. leave related variables declaration
10. Line number first, then description because it's easier to look up descriptions upon lines, e.g. Line 13: this line's description
In Wiki page style, words before TOC is like preface. The "overview" should belong to one part of content and should be made as a header.
When using third party library, specify its version
Store example codes in a version control repository. They can be changed or verified in the future.
use an editor with a spell checker
Write directly on wiki page instead of writing in a word processor.
create a separate book for new version instead of modifying original books
e.g. for version 3.0.0 - http://books.zkoss.org/wiki/Documentation:Books/ZK_Spreadsheet_Essentials_3

Learning Resource

English Writing:

The Elements of Style, William Strunk, Jr ., 1918
Purdue University Online Writing Lab
search "grammar girl" for grammar tips

Technical Writing:

Problem

no offline editor
no version control
verbose syntax
pdf edition cuts code

potential tool: http://gitbookio.github.io/javascript/basics/comments.html

ZK Documentation Format

No version history table for a page having subsections links. (e.g. ZK_Developer's_Reference/Event_Handling)

Message Template

Standard:

Note: note message

Deprecated:

[i] Note: note message

Warning: warning message

Not Work sample:

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

Font design

http://3.7designs.co/blog/2008/06/10-examples-of-beautiful-css-typography-and-how-they-did-it/

Deprecated

User:Hawk/Simple ZK deprecated

User:Hawk/ZK Brief Intro and Simple Architecture

User:Hawk/temp

Supplement

http://books.zkoss.org/wiki/User:Jimmyshiau
Listbox, ZK container's default size, ID generator, Debug Client Error
http://books.zkoss.org/wiki/Getting_Involved
guide customers how to give us required data for debugging.
User:Hawk/Selector Syntax
User:Hawk/Session Timeout Configuration
User:Hawk/Detach a Component under MVVM
User:Hawk/org.zkoss.zul.listbox.DataLoader.class
User:Hawk/org.zkoss.zul.grid.DataLoader.class

@@ Line 10: / Line 10: @@
 = What is the maximal rows and columns ZSS supports?=
-ZSS renders cells on demand instead of rendering all cells at once in a browser, but it loads a file's whole content into memory. So basically the maximal rows and columns it supports depend on your server's memory.
+ZSS renders cells on demand instead of rendering all cells at once in a browser, but it loads a file's whole content into the memory. So the bigger memory your server has, the more rows and columns ZSS can load.
-But even if you have sufficient memory, loading time could be an issue. Because loading time grows linearly with cell number. Under our test machine, if loading 1 million cells with a text takes 65 seconds, loading 2 million cells takes 139 seconds, and loading 4 million cells takes 315 seconds. The time could be too long to be acceptable by users. You can measure the loading time on your machine first.
+But even if you have sufficient memory, loading time could be an issue. Because loading time grows linearly with cell number. Under our test machine, loading 1 million cells with texts takes 65 seconds, loading 2 million cells takes 139 seconds and loading 4 million cells takes 315 seconds. As the cell number grows, the time could be too long to be acceptable by users. You can measure the loading time on your machine first.
 <!--

Anonymous

Difference between revisions of "User:Hawk"

Namespaces

More

Page actions