Tip Sense:Tip Article Structure

From Tip Sense

Jump to: navigation, search

Contents

Structure of a Tip Article page

Just because there is a one page detailed information on structure of a Tip Article, it doesn't mean to scare you.

Because when you create a new Tip Article by following Start a New Tip Article button at front page of Tip Sense. An empty template already created for you. All you do is simply fill in the template. However it is a good idea to know details about structure of a Tip Article and that is why this page is created. So new administrators and users with more interest can learn from it and eventually suggest improvements.

Having a consistent structure of Tip Article ensures that visitors can always quickly find information that they are looking for.

Main Parts of a Tip Article

Tip Sense community decided that a Tip Article should have three main parts.

  • Header
  • Body
  • Footer

Header

  • Header is a mandatory part of a Tip Article. It tells a lot about the Tip Article itself.
  • Mainly there are three elements inside a header:
  • Category
  • See Also
  • About

Category (Element of header)

  • This is where you specify which category your Tip Article should belong to.
  • If you are uncertain about the category where your new Tip Article should go to, you can leave it by not adding any category at all. Someone from admin team can take care of this for you.
  • Example:
  • [[Category:Computer Internet]]
  • Above line will add your Tip Article to Computer Internet category if it exist. If there is no category called Computer Internet, then the above line will actually create a category by that name for you.
  • Feel free to add multiple categories if you think that your Tip Article can belongs to multiple categories. For example if there were another category already existed by the name of Software. You can place this computer related article in both categories as shown in example below.
  • Example:
[[Category:Computer Internet]]
[[Category:Software]]

See also (Element of header)

  • See also element is a mandatory element, which is also automatically added to the template. This tells user about tips which are related to the current Tip Article.
  • Example:
  • {{seaalso|content={{REPLACE_YOUR_CATEGORY_NAME Related}}|state={{Startstate}}}}
  • Replace (REPLACE_YOUR_CATEGORY_NAME Related) with your category as shown below:
  • Example:{{seaalso|content={{Computer Internet Related}}|state={{Startstate}}}}
  • Note how only REPLACE_YOUR_CATEGORY_NAME was replaced above with real category name. But Related was untouched.

About (Element of header)

  • This is a mandatory element, which is also automatically added to the template. It consist of two lines.
  • It gives a general few words idea about your Tip Article.
  • Example:
==About==
{{Abouttips|contentabout=REPLACE_ABOUT}}
  • Replace REPLACE_ABOUT with a few word that are about your article.
  • For example if your article was about Computer and Internet then actual line will look like below:
  • Example: {{Abouttips|contentabout=computers and internet}}
  • Note against the rules, how words are starting with small case because they will be added inside a already started section.

Body of a Tip Article

  • Of course mandatory few sample sections are automatically added to the template when you create new Tip Article.
  • Body part consist of as many sections as users want to add. And it continue to grow as more and more users jumps in to add more Tips to an existing Tip Article, and add new Tip section to the article.
  • What is a section?
  • Any phrase of few words which is generally a sub topic of the main subject of your Tip Article can be made a section.
  • Example:
  • ==Checking Speed of broadband connection==
  • Section line has to be enclosed with ==. Above line will create a section that is related to our example's main subject, which is about Computers and Internet.
  • You can add as many sections as you like.
  • Format of Tips inside sections:
  • Tips are defined as condensed information.
  • It is very important that each Tip should not be more than few lines, at most three lines. If it is more than that, then better to break it into multiple Tips.
  • Each tip always start with a (*) asterisk, this will auto format the tip into bullet.
  • Related Tips about a section should be pulled into one section. Other types of Tips or not related should go into their own sections.
  • If Tips are let say more than 20 then generally it is a good idea to look back refactor and create a new section with more Tips instead of squeezing them all into one.
  • Whenever possible if a Tip refer an article that is already present at Tip Sense then a link for that article should be provided.
  • For example if this was the Tip Article I was writing and I want to say check Tip Article on writing good emails. Below is how I will add link to an existing Tip Article.
  • To know more about writing good email click [[Tips On Writing Good Email | Tips On Writing Good Email]] here.
  • It will produce this To know more about writing good email click Tips On Writing Good Email.

Footer

Footer is mandatory part and also auto generated for you in the template at the bottom area of Tip Article. It is consisting of four main elements as described below

  • Sources/Reference
  • Authors
  • Bookmark
  • Keyword/description.

Sources/Reference (Element of Footer)

  • Mainly tells visitors about source of the Tips. So they can always check for comprehensive details.
  • Feel free to mention source of information for example WikiPedia, library, word of mouth, internet, books etc.
  • In auto generated template there are samples on how to create links.
  • Please make sure to delete links that is provided in template. You can either leave it empty or replace with link of source that you want to mention.

Authors (Element of Footer)

  • This is an optional section again auto generated for you in the template. If you don want to be known that you authored this Tip Article feel free to leave this element or take it off completely altogether.
  • If you want your name to be put here you can add --~~~~ this will auto replace your username with date and time of your contribution. If you are not a registered users then your IP will be displayed as author name.

Bookmark (Element of Footer)

  • This element is mandatory pretty much no work for you, template already created it for you, but details given below. All you need to do is leave it untouched.
  • Example:
  • {{Bookmark}}
  • This tag simply display social bookmarks, so visitors can book mark individual Tip Article.

Keywords/Description (Element of Footer)

  • Mandatory section auto generated for you, contains mainly two lines.
<keywords content="Emails, Good Emails, Write Good Emails"/>
<metadesc content="Very Short and precise Tips and Check Lists for writing good Emails, feel free to add and update more. Hope you find it useful"/>
  • First line with keyword: - Here you should provide relevant keywords that a common visitor will use to search on Internet for this Tip Article. No rocket science here keys words should be directly related to the Tip Article itself. Rule of thumb is that you should use only those words as keywords which are part of and present in the Tip Article.
  • Second line with description: - Here you should short description on what the Tip Article is about. Template already have a well formatted line for you. All you need to do is update for correct subject.

Hope you find this detailed structure useful, if you have comments feedback, more questions please feel free to write at AdminsTeam@TipSense.org.

Retrieved from "http://www.tipsense.org/en/Tip_Sense:Tip_Article_Structure"
Personal tools
Sponsored Links