Skip to main content

Content Guidelines

Guidelines for editors.

General Guidelines

These guidelines apply to all sections of the wiki.

  • Content must abide by the Atelier community rules.
    • They are posted in the Discord server and are also mirrored here.
  • Content must be written in English.
  • Content must be kept reasonably legible.
    • Please be as grammatically correct as possible. 
    • Avoid excessively long sentences and paragraphs.
    • Organize well, whether it be formatting, headers, or content ordering.
    • Don't go overboard with formatting.
      Use the stock text size, font, color, and formatting aside from situations where it's necessary to deviate.
  • Plagiarism is prohibited.

Common Wiki Section

This is applicable to all wiki shelves not under the Original Content shelf.
This is also the group of pages for "traditional wiki-style" content that remains objective - for more informal and self-authored content, see the Original Content section below.

General Rules

  • Keep content objective, third-party, and "wiki-style".
    • The style of writing should fit in with text out of a wiki, information resource, technical documentation, or encyclopedia.
    • Use of first-person speech, conversational forms, and pronouns are prohibited aside from as excerpts.
  • Place books, chapters, and pages under reasonable organization.
    • Avoid duplicate content.
    • Separate things out into chapters and pages where applicable.
      As a general rule of thumb, if a reader would have trouble figuring out which citation is for which area of the page when looking at the citations section, it's time to separate the page into multiple pages.
    • An example of the rough scope of content is as follows:
      • Shelf: PCB Design
      • Book: Microcontrollers
      • Chapter: AVR Microcontrollers
      • Page: Atmega32u4
  • Verify correctness of content as much as possible.
  • Make sure content is meaningful - for example, don't copy-paste a datasheet since it offers no value over just reading the datasheet.
  • Guides and tutorials may be placed into the common wiki sections; however, they must be indisputably objective guides.
    • For example, a guide for installing KiCad or Git can be written into the common wiki. 
    • However, a guide on "how to design a keyboard PCB" or "how to design a case" is very author-specific, and should not be placed into the common wiki.
      Write these in the Original Content section instead.
    • When in doubt, ask in the Discord community's wiki channels.
  • Don't conduct editing wars.
    • When there's a possible revision or conflict of information, use the Discord community's wiki channels to discuss solutions.
  • Citations are necessary. See below.

Citations

Due to the niche nature of keyboard design, there won't always be a third-party source to site.
To resolve this, the Atelier wiki allows for two types of sources: External Citations and Internal References.

General rules
  • Cite sources in APA format.
  • When possible, use external citations over internal/self-authored references.
  • Pick meaningful sources of reasonable trustworthiness and applicability to the topic.
    Avoid sources which are controversial, would lead to conflict, would endanger the reader if visited, or would otherwise go against the Atelier community rules and guidelines.
Internal References
  • When external citations are inapplicable or nonexistent, cite internal references.
  • First write the content to cite in the Original Content section described below, or on your own site/page.
    Then, cite it in typical website APA style but with a Internal Reference: notice before the site name.

Usernames (Year, Month Day). Article Title. Internal Reference: Atelier Wiki or Site Title. URL

  • While Discord conversations are technically not valid APA sources, due to the nature of keyboard design and fragmented info often found on Discord, there is an exception for this wiki that allows for referencing them.
    If you are referencing an Atelier Discord community discussion (Discord forum threads or chat conversations), cite it as follows:

Usernames (Year, Month Day). Conversation Topic Overview [Discord Conversation]. Internal Reference: Atelier Discord. URL

Inserting Citations
  1. First, move the text cursor to the point where you want to insert the inline superscript, then click the footnote button in the toolbar.1
    This popup does not allow for formatting, so insert the APA citation without italics or whatnot.
    image.png
  2. At this point, the footnote has been inserted. A superscript citation entry will appear. 
  3. Scroll to the bottom of the page and find the footnote.
    Apply formatting such as italics here to convert to valid APA formatting.

    image.png

  4. For removing citations in case of a mistake, remove both the superscript and footnote entry simultaneously.

 

Original Content Section

This section exists for guides and references that are original works.
Examples are the following:

  • Primary/original works and research
  • Single-author guides and tutorials, especially ones that are based on a specific methodology preferred/developed by the author
  • Development logs and stories
  • Similar content which are heavily user-bound and would not fit well within the structure of a typical wiki.

General Rules

  • Wiki editors may request an Original Content book for themselves, in which they can write original content.
    For requesting a user book, please ping a wiki manager or ai03 in Discord.
  • Within this section, users may only write in their own book.
  • Pages in this section may endorse specific designers, designs, brands, methodologies, and similar as long as they are of reasonable scope and applicable to the page. 
    If doing so, make sure it is within scope of the Atelier community guidelines/rules.
  • For general knowledge which would fit well within the Common Wiki section, please contribute to the Common Wiki section instead.
  • The style of writing within this category can be a lot less formal and strict than in the Common Wiki.
  • Citations are necessary only where a lack of would be plagiarism.

Original Content Disclaimer

Since content in this section is more empirical and less stringently moderated than the Common Wiki, all pages in the Original Content section must include the following disclaimer at the very top of the page.

Original Content Disclaimer

This page is under the Original Content section of the wiki.

  • Pages in this section may include opinion- or methodology-based content.
  • Pages in this section may include original research.
  • Pages in this section are primarily written by a single author.
  • Pages in this section are generally less error-checked than the common wiki sections. 

Learn more


1 Authors (Year, Month Day). Article Title. Site Title. URL
Back to top