Contents

1. Rule for Content Structure

2. Rule for Formatting Styles

• List the contents to be covered.

On the top of each page, it would be good idea to write the content of the page list them, and link their sub titles. What I use mainly is the following:

• Overview
• Tag
• Attribute
• Code Example
• Output Example
• Description

• Use Sub title to separate the sub topic.

Using sub title make user to be able to understand what he/she is looking at. This categorized sub tile also help user to read its contents visually.

• Content should include the following.
• Tag should be indicated for the purpose of the creality of the topic.
• Each attribute should be highlighted to distinguish between syntax and optional value.
• Code Example should be dealt with one topic and unrelated code should be minimized.
• Output should be exactly the same as the code example above to avoid user from being confused.
• Description should be the comment for the Code and Output example and provide the detail explanation.

• Use Table for the summary of the topics

Sometimes, it would be good idea to summarized the topics with table. It makes the content more clear than using text only.

• Always Consider User.

Since there are users to look at the site, always consider the users. They might not read every articles up to the end. It would be good idea to consider readability and clearity of content.

• Use write back ground for the academic document.

Even though using color for background seems nice and gorgeous, but it would be good idea to use monotone text and write-based back ground for academic document.

• Make alternative CSS for the preference.

Some of user could feel my site monatomic. In this case, let user choose the alternative CSS file. User could choose the his favorite theme. Since each person has different favor for the color and appearance, it would be good idea to make the different CSS to be chosen.

• Use "mono" font for the Tags.

To make user distinguish tag from the other text easily, Use a specific font for the syntax like "mono". User could avoid misread and mis understand the tag syntax.

• Place some"Back" buttons on the page.

Use back button to shortcut to go back to the previous page or top of the page. Even though recent browsers have the back button, but it's still user friendly if the page can give the use proper instruction to go back to the previous or top page.

• Use CSS file for each page.

From the point of view of maintenance, it would be good idea to use the CSS file. It helps not only maintenance of the page, but also uniformity of the entire pages.

• Don't place Style definition into the current html file.

Instead of placing style definition into the current html file, it would be better to import the external CSS file to the current html file. It make the HTML file more clear and simple so that it helps administrator find the bug and misconstruction.

• Don't forget checking spell check.

Use spell check on your HTML software. Otherwise write your document on the other editor which has the spell check, then import and paste the document on the html file. This could avoid from careless misspelling.

• Make the site and page more simple.

Trimming out the garbage code and comment makes user more readable. Not only making one page simple, but also making entire site more simple makes user more easily reach the page he/she wants to see.