Sample Article Structure

From RCGRS MRT Wiki
Revision as of 11:14, 23 April 2023 by DErik (talk | contribs) (Created page with "==Synopsis:== This article may describe a particular product. Or provide the steps in performing a specific task. Or provide an explanation of something. Describe what this article is about. *Be concise; mention just the main goal of the article. *Be clear; don't use words or acronyms without explaning them. *Be complete; cover all the relevant issues regarding this topic, but don't get too verbose. Include pictures/videos. But remember to be consise. *Be correct. I kn...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

Synopsis:

This article may describe a particular product. Or provide the steps in performing a specific task. Or provide an explanation of something.

Describe what this article is about.

  • Be concise; mention just the main goal of the article.
  • Be clear; don't use words or acronyms without explaning them.
  • Be complete; cover all the relevant issues regarding this topic, but don't get too verbose. Include pictures/videos. But remember to be consise.
  • Be correct. I know you are, but check your work for typos, links to other references that don't work, missing references and links.

The structure of the article may change based on its purpose. For example, an explanation of something may not require any sectioning as done below, but instead may require sections to describe alternatives or substitutions.

Product or Item Description:

This may be all that is needed for a particular item. But there may be other products that are similar or related to this product. Put references in here to those.

Materials Needed:

For performing a task, such as building a house, laying out track, putting features (ponds, roads, forests, people) in the layout, creating control items (switches, RR crossing gates, sensors to light buildings or active other things). List the materials, and the tools. Provide alternatives if possible and appropriate.

Steps:

List the steps needed to perform the task in a logical manner. Ya, I know you will.

  • Bullet list of steps for actioins that can be done in any order.
  1. Numbered steps for actions that must be done in a specific order.

Include pictures and videos where possible and appropriate.

Uses and Alternatives:

Describe where the product or item might be used and what alternatives there are to using it. You might include a list of pros and cons to using the product or its alternatives.

Cautions:

Identify uses to which the product should NOT be applied. Identify things that should be done, or not, to protect or preserve the product. Identify things that should be done when using the product, such as environmental conditions (eg., use a fan, do it outdoors, wear mask or googles) or special materials to use or avoid (eg., certain filaments or resins for specific 3D printers).

References and Additional Info:

A special list can be created here. But be aware that these can be embedded in the stuff above, and then have the wiki software automatically generate a list of references. I'm sure you've seen that section at the bottom of many Wikipedia articles. So the list here should be in addition to any references you already included in the above.