Difference between revisions of "User:Hawk"
From Documentation
| Line 14: | Line 14: | ||
== Ready for Publish== | == Ready for Publish== | ||
| − | |||
== Suspend == | == Suspend == | ||
| Line 48: | Line 47: | ||
# [[ZK_Studio_Essentials]] | # [[ZK_Studio_Essentials]] | ||
# [[Small_Talks/2013/April/New_Features_of_ZATS_Mimic_1.1.0]] | # [[Small_Talks/2013/April/New_Features_of_ZATS_Mimic_1.1.0]] | ||
| + | # [[Small_Talks/2013/June/ZK Binding Tracker - A Chrome Extension]] | ||
| − | == My | + | |
| + | == My Practice of Writing Documents == | ||
# Write directly on wiki page instead of writing in a word processor. | # Write directly on wiki page instead of writing in a word processor. | ||
# Pre-write quickly first. | # Pre-write quickly first. | ||
| Line 57: | Line 58: | ||
| − | == Writing | + | == Writing Checklist == |
# Describe the purpose or context at the beginning. | # Describe the purpose or context at the beginning. | ||
| Line 71: | Line 72: | ||
## Picture should present just exactly enough information. | ## Picture should present just exactly enough information. | ||
## Set align to center. | ## Set align to center. | ||
| − | ## Shrink size if a picture | + | ## Shrink size if a picture's width is wider than half of a page. |
# Code snippet: | # Code snippet: | ||
## Focus on a general case not a specific one. | ## Focus on a general case not a specific one. | ||
| Line 79: | Line 80: | ||
## Keep number of codes as fewer as possible to reduce readers' burden. | ## Keep number of codes as fewer as possible to reduce readers' burden. | ||
## Highlight key points in descriptions of code example. (Because most engineers read code first instead of text) | ## Highlight key points in descriptions of code example. (Because most engineers read code first instead of text) | ||
| − | # | + | # When using third party library, specify its version |
| Line 92: | Line 93: | ||
** Line number first, then description because it's easier to look up descriptions upon lines. | ** Line number first, then description because it's easier to look up descriptions upon lines. | ||
*** e.g. Line 13: this line's description | *** e.g. Line 13: this line's description | ||
| + | |||
== Message Template== | == Message Template== | ||
Revision as of 01:25, 28 June 2013
Documentation
Under Editing
ZK_Spreadsheet_Quick_Start_Guide_3.x
Under Review
Ready for Publish
Suspend
User:Hawk/Create Data Binding Programmatically User:Hawk/Tutorial Extension-UnitTest
Already published
- Small_Talks/2011/December/MVVM_in_ZK6:in_Contrast_to_MVC
- Small Talks/2012/January/Ajax GSP with ZK
- Small Talks/2012/January/Enrich Grails Server Pages (GSPs) with ZK
- Small_Talks/2012/January/MVVM_Extension:_Access_UI_Components_Inside_ViewModel
- Small_Talks/2012/February/MVVM_in_ZK6:_Form_Binding
- Small_Talks/2012/February/MVVM_in_ZK6:_Work_with_Spring
- ZK Developer's Reference/MVVM (whole chapter)
- Small Talks/2012/April/The Dawn of ZK Application Test Suite:Mimic Library
- Small Talks/2012/April/Shining ZATS Mimic
- ZATS Essentials
- ZK Getting Started/Learn ZK in 10 Minutes
- ZK Getting Started/Get ZK Up and Running with MVC
- ZK Getting Started/Get ZK Up and Running with MVVM
- Small Talks/2012/October/Binding with Collection and Selection
- Small_Talks/2012/November/How_to_Apply_Responsive_Design
- ZK Developer's Reference/Integration/Middleware Layer/Spring
- ZK Developer's Reference/Integration/Middleware Layer/CDI
- ZK Developer's Reference/Integration/Persistence Layer/Hibernate
- ZK Developer's Reference/Integration/Persistence Layer/JPA
- Small_Talks/2013/January/Building_User_Interface_Programmatically_with_Richlet
- ZK Developer's Reference/Integration/Security/Spring Security
- ZK Essentials
- Small_Talks/2013/April/New_Features_of_ZK_Studio_2.0.0
- ZK_Studio_Essentials
- Small_Talks/2013/April/New_Features_of_ZATS_Mimic_1.1.0
- Small_Talks/2013/June/ZK Binding Tracker - A Chrome Extension
My Practice of Writing Documents
- Write directly on wiki page instead of writing in a word processor.
- Pre-write quickly first.
- create a separate book for new version instead of modifying original books
- Store example codes in a version control repository instead of dropping them. They will be changed in the future.
Writing Checklist
- Describe the purpose or context at the beginning.
- 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.
- keep consistent style in code or describing way in multiple related articles
- Summary at the end. (for small talk)
- Check header, footer, TOC, subsections, references
- Check overall article's layout.
- Picture is better than words.
- Picture should be elegant.
- Picture should present just exactly enough information.
- Set align to center.
- Shrink size if a picture's width is wider than half of a page.
- Code snippet:
- Focus on a general case not a specific one.
- Keep as short as possible.
- Demonstrate only key concepts and remove irrelevant codes.
- Demonstrate the correct API usage instead of work-around
- Keep number of codes as fewer as possible to reduce readers' burden.
- Highlight key points in descriptions of code example. (Because most engineers read code first instead of text)
- When using third party library, specify its version
Document Style
- Image
- make it center
- Shrink the size for too big one
- Code snippet
- give short description for a code snippet for its purpose
- Extracted the key part
- leave related variables declaration
- Line number first, then description because it's easier to look up descriptions upon lines.
- e.g. Line 13: this line's description
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