Difference between revisions of "Guidelines on Writing a Good Article"
***** (***** | *****) |
***** (***** | *****) m |
||
| (24 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
| + | {{Back to Help Portal}} | ||
| + | == Article Theme == | ||
| − | + | Energypedia is a wiki based platform for information on renewable energy, energy access and energy efficiency in the context of developing countries. Therefore, all articles on energypedia should fit in with the above mentioned themes. | |
| − | |||
| + | == Article Title and Headings == | ||
| − | + | The title of the article should reflect the topic of the article. Please capitalise the first letter of all key words in the article title and headings. For example, instead of writing "Biomass Energy" as the article title, please write "Biomass Energy". Be as specific as possible. For example, the title "Biomass Energy" is quite general and people would expect a more introductory text on the topic. But if you're writing about, say, the results of a project in a particular region of Rwanda, you could use the title "The role of biomass energy in Eastern Rwanda". Mentioning the country or a technology in the title is a good way to make it more specific and meaningful to the reader. | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | + | == Article Structure == | |
| − | + | A good article should have the following structure: | |
| − | + | * '''[[#Overview|Overview / Introduction]]''' | |
| + | * '''[[#Main_Part|Main Part]]''' | ||
| + | * '''[[#Further_Information|Further Information]]''' | ||
| + | * '''[[#References|References]] '''(please use appropriate references within your article) | ||
| + | * '''[[#Article_Categories|Categories]] '''(categorise your articles according to the theme of the article) | ||
| − | + | === 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 [[Add Headings|different headings]]. |
| − | + | === Further Information === | |
| − | + | This part should include links to other articles or relevant documents for additional information. | |
| − | + | === References === | |
| − | + | In order to ensure a high quality of articles and avoid plagiarism, 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 section. | |
| − | + | For instructions on how to add references please see the article: "'''[[Insert References|Inserting References]]'''". | |
| − | == Article Categories | + | === Article Categories === |
| − | To make your articles easily accessible to other energypedia users, don't forget to | + | To make your articles easily accessible to other energypedia users, don't forget to categorise them. Categories help to consolidate the articles into relevant themes, making it easier for other users to search and find them. |
| − | *To see a list of | + | * To see a list of categories used on energypedia, click '''[[Special:Categories|here]]'''. |
| − | *For help on how to | + | * For help on how to categorise articles, please click '''[[Categorize an Article|here]]'''. |
| + | === Article Length === | ||
| − | + | Long articles are difficult to follow and the reader can easily get lost or confused. So please create short articles. If you have a long article, covering for example various topics, break it up into smaller articles and link them together. | |
| − | + | === Add Pictures === | |
| − | + | Images improve the aesthetics of the article and attract users. Therefore, please add images to your article whenever possible. Before adding the image, please [[Upload Pictures and Documents|upload]] it to energypedia and then [[Insert Pictures or Documents|link to it]]. | |
| + | Please add the appropriate copyrights to the images and do not upload images where the copyrights are not clear. | ||
| − | = Integration Into the Wiki Structure | + | == 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 | + | 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 [[Link to an Article|link to another article]] or to [[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 [[Upload Pictures and Documents|uploaded before]]. For instructions on linking to a file, click [[Insert File as Picture / Link|here]]. | |
| + | # '''External Link: '''For instructions on linking to external websites, click[[Link to an External Website|here.]]In case of external links, there is a small arrow next to the link. | ||
| − | |||
| − | |||
| − | + | '''Example''' | |
| − | + | <div class="box">According to the '''World Health Organization ([http://www.who.int/en/ 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.</div> | |
| − | |||
| − | '''Example'''< | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | + | {{Help Magic Words}} | |
| − | [[Category:Help | + | [[Category:Help]] |
Latest revision as of 11:15, 24 March 2025
Article Theme
Energypedia is a wiki based platform for information on renewable energy, energy access and energy efficiency in the context of developing countries. Therefore, all articles on energypedia should fit in with the above mentioned themes.
Article Title and Headings
The title of the article should reflect the topic of the article. Please capitalise the first letter of all key words in the article title and headings. For example, instead of writing "Biomass Energy" as the article title, please write "Biomass Energy". Be as specific as possible. For example, the title "Biomass Energy" is quite general and people would expect a more introductory text on the topic. But if you're writing about, say, the results of a project in a particular region of Rwanda, you could use the title "The role of biomass energy in Eastern Rwanda". Mentioning the country or a technology in the title is a good way to make it more specific and meaningful to the reader.
Article Structure
A good article should have the following structure:
- Overview / Introduction
- Main Part
- Further Information
- References (please use appropriate references within your article)
- Categories (categorise your articles according to the theme of the article)
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.
Further Information
This part should include links to other articles or relevant documents for additional information.
References
In order to ensure a high quality of articles and avoid plagiarism, 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 section.
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 categorise them. Categories help to consolidate the articles into relevant themes, making it easier for other users to search and find them.
- To see a list of categories used on energypedia, click here.
- For help on how to categorise articles, please click here.
Article Length
Long articles are difficult to follow and the reader can easily get lost or confused. So please create short articles. If you have a long article, covering for example various topics, break it up into smaller articles and link them together.
Add Pictures
Images improve the aesthetics of the article and attract users. Therefore, please add images to your article whenever possible. Before adding the image, please upload it to energypedia and then link to it.
Please add the appropriate copyrights to the images and do not upload images where the copyrights are not clear.
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:
- 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.
- External Link: For instructions on linking to external websites, clickhere.In case of external links, there is a small arrow next to the link.
Example
