Difference between revisions of "Guidelines on Writing a Good Article"

From energypedia
***** (***** | *****)
***** (***** | *****)
m
Line 1: Line 1:
{{template:Tabs-1
+
= <span style="font-size: 21.76px; line-height: 30.464px; background-color: initial;">Article Title</span><br/> =
|Energypedia_Community:_Help|Back to the Help Portal
 
|
 
}}
 
= Article Title =
 
  
 
The title of the article should reflect the theme of the article. Kindly capitalise the first letter of all main words in the article title. For example, instead of writing "'''energy source"''' as the article title, please write "'''Energy Source'''".
 
The title of the article should reflect the theme of the article. Kindly capitalise the first letter of all main words in the article title. For example, instead of writing "'''energy source"''' as the article title, please write "'''Energy Source'''".
  
 +
<br/>
  
 
= Article Structure =
 
= Article Structure =
Line 12: Line 9:
 
A good article should have the following structure:
 
A good article should have the following structure:
  
*'''Overview''' or '''Introduction'''
+
 
*'''Main Part'''  
+
*'''[[#Main_Part|Main Part]]'''
*'''Conclusion'''<br/>
+
*'''[[#Conclusion|Conclusion]]'''<br/>
*'''Further Information '''
+
*'''[[#Further_Information|Further Information]]'''
 
*'''[[#Article_References|References]] '''(please use appropriate references within your article)
 
*'''[[#Article_References|References]] '''(please use appropriate references within your article)
 
*'''[[#Article_Categories|Categories]] '''(categorize your articles according to the theme of the article)<br/>
 
*'''[[#Article_Categories|Categories]] '''(categorize your articles according to the theme of the article)<br/>
  
 
== Overview ==
 
== Overview ==
The "Overview" section in each article should give a short summary of the article so that other users can get an initial understanding of the content of the article.
+
 
 +
The "Overview" section in each article should give a short summary of the article so that other users can get an initial understanding of the article.
  
 
= Main Part =
 
= Main Part =
The part should be clustered into (should be clustered into [[Help:Add_Headings|different headings]]) so that it is easy for other users to read through.
+
 
 +
The body of the article should be clustered into [[Help:Add Headings|different headings]].&nbsp;
  
 
= Conclusion =
 
= Conclusion =
 +
 
This part should include the major findings of the article.
 
This part should include the major findings of the article.
  
 
= Further Information =
 
= Further Information =
 +
 
This part should include to links to articles or other relevant documents for additional information
 
This part should include to links to articles or other relevant documents for additional information
  
 
== Article References ==
 
== Article References ==
  
In order to ensure a high quality of articles on energypedia, we highly encourage all our authors to add relevant references to their articles.Please include the author's name, year of publication, title of publication and link to it if possible in the reference.
+
In order to ensure a high quality of articles on energypedia, we highly encourage all our authors to add relevant references to their articles. Please include the author's name, year of publication, title of publication and link to it if possible in the reference.
  
 
-> For instructions on how to add references please see the article: "'''[[Help:Insert References|Inserting References]]'''".
 
-> For instructions on how to add references please see the article: "'''[[Help:Insert References|Inserting References]]'''".
  
 +
<br/>
  
 
== Article Categories<br/> ==
 
== Article Categories<br/> ==
Line 45: Line 47:
 
*For help on how to categorize articles, please click '''[[Help:Categorize an Article|here]]'''.
 
*For help on how to categorize articles, please click '''[[Help:Categorize an Article|here]]'''.
  
 +
<br/>
  
 
= Article Length =
 
= Article Length =
  
Long articles are difficult to follow and the reader can easily get lost or confused. Therefore, please create short articles. In the case of a long articles, kindly break them into smaller short articles and '''[[Help:Link_to_an_Article|link them to one another]]'''.
+
Long articles are difficult to follow and the reader can easily get lost or confused. Therefore, please create short articles. In the case of a long articles, kindly break them into smaller short articles and '''[[Help:Link to an Article|link them to one another]]'''.
  
 
<br/>
 
<br/>
 
  
 
= Integration Into the Wiki Structure<br/> =
 
= Integration Into the Wiki Structure<br/> =
 
  
 
== Links (External/Internal)<br/> ==
 
== Links (External/Internal)<br/> ==
  
Links are especially useful to other users who may want to get further information on a topic. They help to make an article short and precise by interlinking between articles and not repeating information that has already been documented somewhere else.
+
Links are especially useful to other users who may want to get further information on a topic. They help to make an article short and precise by interlinking between articles and not repeating the information available elsewhere.
  
Links also help structure a wiki so that individual articles do not get lost. On energypedia we usually distinguish between two types of links:
+
Links also help to structure a wiki so that the individual articles do not get lost. On energypedia we usually distinguish between two types of links:
  
#'''Internal Link: '''The first option is to [[Help:Link_to_an_Article|link to another article]] or to [[Help:Link_to_a_Headline|link to a particular headline]] in another or the same article, within energypedia. If you want to link to a file it needs to be [[Help:Upload_Pictures_and_Documents|uploaded before]]. For instructions on linking to a file, click [[Help:Insert_File_as_Picture_/_Link|here]].
+
#'''Internal Link: '''The first option is to [[Help:Link to an Article|link to another article]] or to [[Help:Link to a Headline|link to a particular headline]] in another or the same article, within energypedia. If you want to link to a file it needs to be [[Help:Upload Pictures and Documents|uploaded before]]. For instructions on linking to a file, click [[Help:Insert File as Picture / Link|here]].
#'''External Link: '''Using external links, you can [[Help:Link_to_an_External_Website|link to external articles in the web]].
+
#'''External Link: '''Using external links, you can [[Help:Link to an External Website|link to external articles in the web]].
  
 
{| cellspacing="1" cellpadding="1" border="1" style="width: 100%"
 
{| cellspacing="1" cellpadding="1" border="1" style="width: 100%"
Line 71: Line 72:
  
 
|}
 
|}
 
<br/>
 
 
 
= Further Information =
 
 
*[[Energypedia_Community:_Help|Help portal on energypedia]]
 
 
<br/>
 
  
 
__NOAUTHORLIST__
 
__NOAUTHORLIST__
 +
__NOEDITSECTION__

Revision as of 12:10, 1 August 2016

Article Title

The title of the article should reflect the theme of the article. Kindly capitalise the first letter of all main words in the article title. For example, instead of writing "energy source" as the article title, please write "Energy Source".


Article Structure

A good article should have the following structure:


Overview

The "Overview" section in each article should give a short summary of the article so that other users can get an initial understanding of the article.

Main Part

The body of the article should be clustered into different headings

Conclusion

This part should include the major findings of the article.

Further Information

This part should include to links to articles or other relevant documents for additional information

Article References

In order to ensure a high quality of articles on energypedia, we highly encourage all our authors to add relevant references to their articles. Please include the author's name, year of publication, title of publication and link to it if possible in the reference.

-> For instructions on how to add references please see the article: "Inserting References".


Article Categories

To make your articles easily accessible to other energypedia users, don't forget to categorize them. Categories help consolidate the articles on energypedia into relevant themes, making it easier for other users to search and find them.

  • To see a list of articles, click here.
  • For help on how to categorize articles, please click here.


Article Length

Long articles are difficult to follow and the reader can easily get lost or confused. Therefore, please create short articles. In the case of a long articles, kindly break them into smaller short articles and link them to one another.


Integration Into the Wiki Structure

Links (External/Internal)

Links are especially useful to other users who may want to get further information on a topic. They help to make an article short and precise by interlinking between articles and not repeating the information available elsewhere.

Links also help to structure a wiki so that the individual articles do not get lost. On energypedia we usually distinguish between two types of links:

  1. Internal Link: The first option is to link to another article or to link to a particular headline in another or the same article, within energypedia. If you want to link to a file it needs to be uploaded before. For instructions on linking to a file, click here.
  2. External Link: Using external links, you can link to external articles in the web.

Example
According to the World Health Organization (WHO) as many as 1.6 million people die each year as a result of it. This can be compared with one death every 20 seconds.