Skip to main content

Article Layout & Organization

Articles (Pages) should be concise, easy to read, and convey singular solutions that are straightforward to implement. Specifically articles should talk about one thing. If you find that your article is covering multiple subjects, split those subjects into multiple articles (pages).

Articles should include the following sections if appropriate:

  • Summary
  • How To
  • Examples
  • Resources

Summary: This briefly describes the content of the article. It could be framed as a problem that needs to be solved and how the solution addresses that problem. It can also be framed as a knowledge summary that describes what the article will discuss.

How To: This the core of the article. It should detail how the solution is implemented. It should include what materials are needed and how to use those materials. This section can be broken down into further sections that are specific to the subject matter.

Examples: This should include real life examples of how this solution has been implemented. External links may be included in this section.

Resources: This section should include links and files to other open source and open knowledge articles and repos that are relevant to the subject matter. When possible, include a mirror to those links as well. Mirrors can be local Hacker | Solar copies, bittorrent seeds, backups, etc.

While the above lists out core sections that should included in each article, further sections can be included if appropriate.