Edit source Discussion

Help:Types of content

From Appropedia
Page data
Authors Gabriel Krause
Published 2007
License CC BY-SA 4.0
Derivatives Ayuda:Tipos de contenido
Automatic translations

This page can serve to guide you as you contribute to Appropedia. There are different types of articles, each described below.

Topic page[edit source]

A topic page is basically information for business purposes, cultural or educational about a product or service that you offer. Its goal is to facilitate the collection, organization, and distribution of knowledge to solve problems or questions related to your business.

Benefits[edit source]

Some of the many benefits that the knowledge base can bring are:

  1. Greater customer satisfaction. A solid knowledge base leads to customer satisfaction, one of the most important competitive factors to ensure the growth of an organization over time.
  2. Increase in customer loyalty. If a user is satisfied they become a loyal customer and that leads to the success of your organization in the long term.
  3. Better customer support. The knowledge base allows you to respond to customer needs 24/7.

Recommendations[edit source]

Some of the best practices for writing a knowledge base article are:

  1. aim for brevity - users are looking for a simple answer, not a poem;
  2. makes reading easier - split long blocks of text by adding lists, titles, and graphics;
  3. add assets - sometimes a photo, video or link turns out to be a faster response;
  4. test and optimize - reshape content based on user feedback until there is a decrease in the number of questions.

Literature Reviews[edit source]

Check this article for a guide: Category:MOST_literature_reviews

What is a literature review?[edit source]

Literature reviews are the heart of how Appropedians research. It involves looking for source material such as papers, patents, and other second-hand information. This is where researchers show their knowledge of the subject they're researching. A literature review is a discussion of existing material in the subject area. Therefore, it will require a collection of published works (printed or online) related to the selected research area.

Preparation of a literature review[edit source]

The preparation of a literature review includes several steps which can be traced back to three phases as described below:

1st phase - Preparation of a literature review

  1. Choose the topic, define the problem and formulate the question.
  2. Identify and select the items to include.
  3. Select the citation model
  4. Organize the included items.
  5. Summary tables of data extraction for analysis.
  6. Development of a concept map

2nd phase - Write the revision

  1. Introduction.
  2. Central body of the revision.
  3. Conclusions.
  4. Citations and references

3rd phase - Check the revision

  1. Content review
  2. Write the review in good style

Devices[edit source]

See a list of devices on Appropedia here: Category:Devices

We recommend to follow: https://www.oshwa.org/sharing-best-practices/

A brief description of a technology and its uses[edit source]

Technology is the science that studies the production processes, methods, and means used in them. In simpler words, technology studies how to make all the objects we use every day.

Regional considerations[edit source]

Such as climate, locating raw materials, etc, as well as cultural, social and political context.

Bill of materials[edit source]

Check this Wikipedia page for more info: https://en.wikipedia.org/wiki/List_of_building_materials

Status tagging[edit source]

For project pages it is important to note the status. Often the investment cost of recreating or building an appropriate technology is high. To overcome this cost, first, there must be adequate information and schematics for a user to trust that there is due diligence in a given design and that the designed device can perform to specifications. Second, there must be a successful history of implementation before an investment in time and resources to employ an innovation can be made. By following the instructions on the page Appropedia:Status, the status of a particular appropriate technology can be shown easily to help users decide on the use of a technology.

See Appropedia:Status for details.

Simple how-to sections for building or using a technology or material[edit source]

  • Product name and general description of the device, its intended use, and intended users.
  • How does the device work? Has it been proven?
  • If it is going to be used in combination with other devices, describe how.
  • General description of the functional elements, e.g. components (software, if applicable).
  • Include visual representations (photos, drawings, diagrams, etc.), clearly indicating components and explanations for a better understanding of the visual material.
  • Technical specifications such as dimensions, etc.

Alternative approaches when building or using a device[edit source]

To build complex training devices

It is important to build training devices that have the purpose of significantly affecting work practices and the territories in which they intervene, trying to build meaningful relationships between all subjects involved both at an operational and institutional level, and between these and the territories in which they operate.

The main part of a training device can consist of the following organized activities:

  • Coordination: it’s necessary to monitor the progress and possibly reorient the work where it’s necessary, to evaluate the results achieved.
  • Distance learning: it might include a platform as a support to the workshops, to stay in touch with the participants or share the work they carried out, etc.
  • Meetings: These could be open to a wider audience, perhaps from other territories or not strictly professionals. Its main goal is to make the work known in a wider way.

Common mistakes to avoid in building or using a technology[edit source]

  1. Lack of good planning for the creation of technology.
  2. The people involved in the creation of technology lack adequate knowledge.
  3. Limited or inadequate budget.
  4. Lack of adequate material for the creation of technology
  5. The environment is not suitable for the creation of technology.
  6. Lack of vision for the future.

Photographs and diagrams for more interesting, informative content[edit source]

The most effective contents of an organization are visual ones, because they have more possibilities, compared to other types of advertising, to be shared on Social Media: for this reason a lot of us now rely heavily on images and videos to communicate a message.

  1. Most of the information transmitted in the human brain, about 93%, is visual;
  2. Much research claims that the human brain is capable of processing images 60,000 times faster;
  3. The images proposed to us have a very profound effect on us, far superior to textual content;
  4. On social networks, the engagement rate is much higher for visual content;
  5. 55% of users who view a page spend less than 15 seconds on it, the goal will therefore be to amaze the public in a very short period of time, and visual content is the best resource to do so.

Case study of a technology being used[edit source]

Technical briefs and books[edit source]

We can define the technical brief as the document in which a problem is studied in order to transmit information, present conclusions, ideas, and, sometimes, recommendations.

See Technical_briefs for more detailed information.

Check copyright licenses and permissions[edit source]

Before you want to publish a photo, article, etc. you need to verify what you can share, re-use or copy legally.

Format (text proofread if OCR)[edit source]

Using the Optical Character Recognition (OCR) technology allows you to transform different types of documents, such as digital photos or PDF files into editable texts very quickly and, above all, effortlessly, as if it were Word documents.

A scanner can’t do what OCR software does, a scanner isn’t enough to extract the relevant information and transform it into a Word format for editing. All it is able to do, in fact, is to create an image of the document, that’s nothing more than a set of white and black or colored points (raster graphics). The OCR technology is able to recognize the characters present in the image and transform them into words to edit them.

  • Upload documents (PDF, consider Archive.org)

See wiki/Design_brief or wiki/Functional_brief for more information.

Skill pages[edit source]

These pages describe and exemplify how to do something through the description of a series of steps that others can learn.

Images[edit source]

See Help:Images for more information

Check this article for a guide: https://commons.wikimedia.org/wiki/Commons:Quality_images

The correct management of images in a website is one of the primary factors for achieving the goal that the site has set itself.

  1. Use the right resolution, the right size and the right weight.You can use many software to optimize your images, Photoshop, LightRoom, Gimp, etc.
  2. Use the right image format. On the web essentially the most used formats are 3: jpeg, png and gif.
  3. Use original and creative images.
  4. Do not use images of others illegally or without citing the sources.

Video[edit source]

See Help:Video for more information

  • Platforms: Youtube, Vimeo

What's a video?[edit source]

Videos represent a very important tool for those organizing training events, such as meetings or classroom courses, so it’s essential to know how to evaluate the quality of a video.

Things to consider when creating a video[edit source]

For a video to be truly communicative it should follow this criteria:

  1. The audio can’t be ambient because the listener will have a hard time understanding the intervention of the speaker. This problem can be solved in post-production with special tools that allow you to reduce the environmental effect.
  2. If the course takes place without an audience, you just need a front camera to record what you’re doing or saying. If, on the other hand, an audience is present, another camera will be needed to follow their interventions.
  3. If you’re doing a monologue, it is recommendable to have slides or graphics to support the video. A good video must use short texts with a readable font and adequate size.

If you need to upload a video to the website, a computer or smartphone camera is enough to record it and upload it.

Basic practical advice[edit source]

Let's see some basic practical advice:

  • Know the subject. Decide your field of interest, document yourself, study, deepen and share your know-how. You don’t need to be an expert.
  • Write a storyboard. That way you will have a schematic view of the things to say and the topics to be covered.
  • Be brief. A couple of minutes maximum.
  • Use neutral backgrounds. A blank wall is ideal.
  • If you want to use a software, choose the right one.
  • Pay attention to the audio. The video is only part of your tutorial. Audio is equally important and must be perfect.
  • Use subtitles and write down what you say. Sometimes video tutorials are often watched in contexts where audio is not possible: at work, on public transport, in the midst of other people, etc. This is much appreciated by users.
  • Use background music only if necessary and, above all, copyright free. Ccmixter.org is a good site for finding open licensed music.
  • Use the right tone. You don't need to be too formal but you don't have to be too conversational. Avoid starting all your videos shouting "HELLO GUYS"! Especially if you want professional results.
  • Spend some time on video editing. Nobody is perfect and it can happen to make mistakes while you’re explaining something. Editing a video is an important part of the job. Cut, shrink, change colors, add effects.
  • Index your video. If you upload it to Youtube, carefully study the text and keywords to enter in the boxes. People will find your video based on what you write there.

Video annotations[edit source]

Annotations are interactive boxes that appear superimposed and contain links to other interactive video content that you might find useful.

|title = How to sew the Olson mask
|description = Instructional video for sewing the Olson mask

YouTube cards[edit source]

YouTube cards allow content creators to link to other videos, YouTube playlists, social networks, etc. The cards are discreet and can only be seen only if the viewer clicks on the small information icon that appears at the top left of the screen. They’re in a thumbnail format which also gives you the option to create a thumbnail that will catch the viewer’s attention.

External links[edit source]

  1. https://en.wikipedia.org/wiki/Wikipedia:Copyrights
  2. https://commons.wikimedia.org/wiki/Commons:Copyright_rules
  3. https://creativecommons.org/licenses/
  4. https://blog.hubspot.com/marketing/chartbeat-website-engagement-data-nj#:
  5. https://sites.google.com/site/graphaize/why-visual-content-marketing-regards-as-the-future-of-online-marketing
  6. https://killervisualstrategies.com/blog/how-our-brains-are-hardwired-for-visual-content.html
  7. https://publications.ici.umn.edu/ties/building-engagement-with-distance-learning/an-overview-framework